diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index de55d89175..b0692b120c 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -136,6 +136,10 @@ "name": "users", "description": "Interact with and view information about users and also current user." }, + { + "name": "code-quality", + "description": "Insights into reliability, maintainability, and efficiency of your codebase." + }, { "name": "codespaces", "description": "Endpoints to manage Codespaces using the REST API." @@ -144,6 +148,10 @@ "name": "copilot", "description": "Endpoints to manage Copilot using the REST API." }, + { + "name": "copilot-spaces", + "description": "Endpoints to manage Copilot Spaces using the REST API." + }, { "name": "security-advisories", "description": "Manage security advisories." @@ -3781,7 +3789,7 @@ "/enterprises/{enterprise}/copilot/policies/coding_agent": { "put": { "summary": "Set the coding agent policy for an enterprise", - "description": "Sets the policy for Copilot coding agent usage across an enterprise.\n\nEnterprise owners can configure whether Copilot coding agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.\n\nOnly enterprise owners can set the coding agent policy for their enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "description": "Sets the policy for Copilot cloud agent usage across an enterprise.\n\nEnterprise owners can configure whether Copilot cloud agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.\n\nOnly enterprise owners can set the coding agent policy for their enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -3805,7 +3813,7 @@ "properties": { "policy_state": { "type": "string", - "description": "The policy state for Copilot coding agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.", + "description": "The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.", "enum": [ "enabled_for_all_orgs", "disabled_for_all_orgs", @@ -3847,7 +3855,7 @@ "/enterprises/{enterprise}/copilot/policies/coding_agent/organizations": { "post": { "summary": "Add organizations to the enterprise coding agent policy", - "description": "Enables Copilot coding agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can add organizations to the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "description": "Enables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can add organizations to the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -3862,7 +3870,7 @@ } ], "requestBody": { - "description": "The organizations to enable Copilot coding agent for", + "description": "The organizations to enable Copilot cloud agent for", "required": true, "content": { "application/json": { @@ -3871,7 +3879,7 @@ "properties": { "organizations": { "type": "array", - "description": "List of organization logins within the enterprise to enable Copilot coding agent for.", + "description": "List of organization logins within the enterprise to enable Copilot cloud agent for.", "items": { "type": "string" } @@ -3941,7 +3949,7 @@ }, "delete": { "summary": "Remove organizations from the enterprise coding agent policy", - "description": "Disables Copilot coding agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can remove organizations from the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "description": "Disables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can remove organizations from the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -3956,7 +3964,7 @@ } ], "requestBody": { - "description": "The organizations to disable Copilot coding agent for", + "description": "The organizations to disable Copilot cloud agent for", "required": true, "content": { "application/json": { @@ -3965,7 +3973,7 @@ "properties": { "organizations": { "type": "array", - "description": "List of organization logins within the enterprise to disable Copilot coding agent for.", + "description": "List of organization logins within the enterprise to disable Copilot cloud agent for.", "items": { "type": "string" } @@ -10849,6 +10857,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } } }, @@ -18791,6 +18803,1561 @@ } } }, + "/orgs/{org}/copilot-spaces": { + "get": { + "summary": "List organization Copilot Spaces", + "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-organization-copilot-spaces" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "spaces" + ], + "properties": { + "spaces": { + "type": "array", + "description": "The list of Copilot Spaces on this page of results.", + "items": { + "$ref": "#/components/schemas/copilot-space" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-spaces-organization-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "post": { + "summary": "Create an organization Copilot Space", + "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/create-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "Team Planning Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Organization space for team planning and coordination" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help the team with planning and coordination tasks" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions for organization members.\n- `no_access`: No default access (default)\n- `reader`: Organization members can read the space\n- `writer`: Organization members can read and edit the space\n- `admin`: Organization members have full admin access to the space", + "default": "no_access" + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/planning.md" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology and holds daily standups" + } + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-space-organization" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + } + }, + "/orgs/{org}/copilot-spaces/{space_number}": { + "get": { + "summary": "Get an organization Copilot Space", + "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/get-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-space-organization" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "put": { + "summary": "Set an organization Copilot Space", + "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "Updated Team Planning Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Updated organization space for team planning and coordination" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Updated instructions to help the team with planning and coordination tasks" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions for organization members. Changing this field requires admin permissions.\n- `no_access`: No default access (default)\n- `reader`: Organization members can read the space\n- `writer`: Organization members can read and edit the space\n- `admin`: Organization members have full admin access to the space" + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "Updated Team Planning Space", + "description": "Updated organization space for team planning and coordination", + "general_instructions": "Updated instructions to help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/updated-planning.md" + } + }, + { + "id": 789, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Team Guidelines", + "text": "Our updated team follows agile methodology and holds daily standups" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-space-organization" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "delete": { + "summary": "Delete an organization Copilot Space", + "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/delete-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "The Copilot Space has been successfully deleted." + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + } + }, + "/orgs/{org}/copilot-spaces/{space_number}/collaborators": { + "get": { + "summary": "List collaborators for an organization Copilot Space", + "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-collaborators-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "collaborators" + ], + "properties": { + "collaborators": { + "type": "array", + "description": "The list of collaborators for this Copilot Space.", + "items": { + "$ref": "#/components/schemas/copilot-space-collaborator" + } + } + } + }, + "examples": { + "default": { + "value": { + "collaborators": [ + { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + } + ] + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + }, + "post": { + "summary": "Add a collaborator to an organization Copilot Space", + "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/add-collaborator-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "actor_type", + "actor_identifier", + "role" + ], + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User", + "Team" + ], + "description": "The type of actor (user or team)." + }, + "actor_identifier": { + "type": "string", + "description": "The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role to grant to the collaborator." + } + } + }, + "examples": { + "user": { + "value": { + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" + } + }, + "team": { + "value": { + "actor_type": "Team", + "actor_identifier": "developers", + "role": "reader" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-collaborator" + }, + "examples": { + "user": { + "value": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "team": { + "value": { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + } + }, + "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { + "put": { + "summary": "Set a collaborator role for an organization Copilot Space", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-collaborator-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "The type of actor (user or team).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "role" + ], + "properties": { + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The new role to grant to the collaborator. Use `no_access` to remove the collaborator." + } + } + }, + "examples": { + "default": { + "value": { + "role": "admin" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-collaborator" + }, + "examples": { + "user": { + "value": { + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "team": { + "value": { + "actor_type": "Team", + "role": "admin", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 + } + } + } + } + } + }, + "204": { + "description": "Response when `role` is `no_access` and the collaborator was removed." + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + }, + "delete": { + "summary": "Remove a collaborator from an organization Copilot Space", + "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/remove-collaborator-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "The type of actor (user or team).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + } + }, + "/orgs/{org}/copilot-spaces/{space_number}/resources": { + "get": { + "summary": "List resources for an organization Copilot Space", + "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-resources-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "$ref": "#/components/schemas/copilot-space-resource" + } + } + } + }, + "examples": { + "default": { + "value": { + "resources": [ + { + "id": 1, + "resource_type": "repository", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42 + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + { + "id": 2, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + ] + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "resources" + } + }, + "post": { + "summary": "Create a resource for an organization Copilot Space", + "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/create-resource-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "resource_type", + "metadata" + ], + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ], + "description": "The type of resource to create." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata.", + "additionalProperties": true + } + } + }, + "examples": { + "free_text": { + "value": { + "resource_type": "free_text", + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + } + } + }, + "repository": { + "value": { + "resource_type": "repository", + "metadata": { + "repository_id": 42 + } + } + }, + "github_file": { + "value": { + "resource_type": "github_file", + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Resource created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "200": { + "description": "Duplicate github_file resource already exists", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "github_file", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "resources" + } + } + }, + "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": { + "get": { + "summary": "Get a resource for an organization Copilot Space", + "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/get-resource-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "resources" + } + }, + "put": { + "summary": "Set a resource for an organization Copilot Space", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-resource-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "Updated resource-specific metadata.", + "additionalProperties": true + } + } + }, + "examples": { + "default": { + "value": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "resources" + } + }, + "delete": { + "summary": "Delete a resource from an organization Copilot Space", + "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/delete-resource-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "resources" + } + } + }, "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", @@ -19337,15 +20904,15 @@ }, "/orgs/{org}/copilot/coding-agent/permissions": { "get": { - "summary": "Get Copilot coding agent permissions for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about which repositories in an organization have been enabled\nor disabled for the Copilot coding agent.\n\nOrganization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Get Copilot cloud agent permissions for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about which repositories in an organization have been enabled\nor disabled for the Copilot cloud agent.\n\nOrganization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/get-copilot-coding-agent-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-cloud-agent-permissions-for-an-organization" }, "parameters": [ { @@ -19362,7 +20929,7 @@ "properties": { "enabled_repositories": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", "selected", @@ -19423,15 +20990,15 @@ } }, "put": { - "summary": "Set Copilot coding agent permissions for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets the policy for which repositories in an organization can use Copilot coding agent.\n\nOrganization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Set Copilot cloud agent permissions for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets the policy for which repositories in an organization can use Copilot cloud agent.\n\nOrganization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/set-copilot-coding-agent-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-cloud-agent-permissions-for-an-organization" }, "parameters": [ { @@ -19447,7 +21014,7 @@ "properties": { "enabled_repositories": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", "selected", @@ -19499,15 +21066,15 @@ }, "/orgs/{org}/copilot/coding-agent/permissions/repositories": { "get": { - "summary": "List repositories enabled for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists the selected repositories that are enabled for Copilot coding agent in an organization.\n\nOrganization owners can use this endpoint when the coding agent repository policy\nis set to `selected` to see which repositories have been enabled.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "List repositories enabled for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists the selected repositories that are enabled for Copilot cloud agent in an organization.\n\nOrganization owners can use this endpoint when the coding agent repository policy\nis set to `selected` to see which repositories have been enabled.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/list-copilot-coding-agent-selected-repositories-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -19575,15 +21142,15 @@ } }, "put": { - "summary": "Set selected repositories for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReplaces the list of selected repositories that are enabled for Copilot coding\nagent in an organization. This method can only be called when the coding agent\nrepository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Set selected repositories for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReplaces the list of selected repositories that are enabled for Copilot cloud\nagent in an organization. This method can only be called when the cloud agent\nrepository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/set-copilot-coding-agent-selected-repositories-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -19598,7 +21165,7 @@ "type": "object", "properties": { "selected_repository_ids": { - "description": "List of repository IDs to enable for Copilot coding agent.", + "description": "List of repository IDs to enable for Copilot cloud agent.", "type": "array", "items": { "type": "integer", @@ -19656,15 +21223,15 @@ }, "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}": { "put": { - "summary": "Enable a repository for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nAdds a repository to the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Enable a repository for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nAdds a repository to the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/enable-copilot-coding-agent-for-repository-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -19705,15 +21272,15 @@ } }, "delete": { - "summary": "Disable a repository for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemoves a repository from the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint.", + "summary": "Disable a repository for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemoves a repository from the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/disable-copilot-coding-agent-for-repository-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -33934,6 +35501,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for this repository. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim.", + "type": "boolean" } } }, @@ -65024,6 +66595,18 @@ }, "assignee": { "$ref": "#/components/schemas/secret-scanning-alert-assignee" + }, + "validity": { + "type": [ + "string", + "null" + ], + "enum": [ + "active", + "inactive", + null + ], + "description": "Sets the validity of the secret scanning alert. Can be `active`, `inactive`, or `null` to clear the override." } }, "anyOf": [ @@ -65090,7 +66673,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" + "description": "State does not match the resolution or resolution comment, assignee does not have write access to the repository, or the requested validity change could not be applied to this alert" }, "503": { "$ref": "#/components/responses/service_unavailable" @@ -76239,6 +77822,1505 @@ } } }, + "/users/{username}/copilot-spaces": { + "get": { + "summary": "List Copilot Spaces for a user", + "description": "Lists Copilot Spaces owned by a user. The authenticated user must have read access to the user's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes the user's own spaces, and public user spaces when accessing another user's spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-copilot-spaces-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "spaces" + ], + "properties": { + "spaces": { + "type": "array", + "description": "The list of Copilot Spaces on this page of results.", + "items": { + "$ref": "#/components/schemas/copilot-space" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-spaces-user-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "post": { + "summary": "Create a Copilot Space for a user", + "description": "Creates a new Copilot Space owned by a user. Only the authenticated user can create spaces for their own account.\n\nUsers can create personal Copilot Spaces for their individual use.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/create-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Personal space for development assistance" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help me with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "no_access" + ], + "description": "The base role that determines default permissions for the space.\n- `no_access`: No default access (default)\n- `reader`: Makes the space publicly readable\nNote: User spaces do not support writer or admin base roles.", + "default": "no_access" + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "My Development Space", + "description": "Personal space for development assistance", + "general_instructions": "Help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/App.js" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Development Notes", + "text": "Focus on clean code principles and modern React patterns" + } + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-space-user" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}": { + "get": { + "summary": "Get a Copilot Space for a user", + "description": "Gets details about a specific Copilot Space owned by a user. The authenticated user must have read access to the Space.\n\nPrivate user spaces require the authenticated user to be the owner of the space.\nPublic user spaces are accessible to any authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/get-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-space-user" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "put": { + "summary": "Set a Copilot Space for a user", + "description": "Updates a Copilot Space owned by a user. Only the authenticated user can update spaces for their own account.\n\nUsers can update their personal Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "Updated Development Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Updated personal space for development assistance" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Updated instructions to help me with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "no_access" + ], + "description": "The base role that determines default permissions for the space. Changing this field requires admin permissions.\n- `no_access`: No default access (default)\n- `reader`: Makes the space publicly readable\nNote: User spaces do not support writer or admin base roles." + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "Updated Development Space", + "description": "Updated personal space for development assistance", + "general_instructions": "Updated instructions to help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/UpdatedApp.js" + } + }, + { + "id": 123, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Development Notes", + "text": "Updated focus on clean code principles and modern React patterns" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-space-user" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "delete": { + "summary": "Delete a Copilot Space for a user", + "description": "Deletes a Copilot Space owned by a user. The authenticated user must be the owner of the space.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a space will remove all associated resources and configurations.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/delete-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "The Copilot Space has been successfully deleted." + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}/collaborators": { + "get": { + "summary": "List collaborators for a Copilot Space for a user", + "description": "Lists all collaborators for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nEach collaborator entry specifies which user has access to the space and at what level (reader, writer, or admin). The space owner is excluded from this list.\n\nTeam collaborators are not supported for user-owned Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-collaborators-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "collaborators" + ], + "properties": { + "collaborators": { + "type": "array", + "description": "The list of collaborators for this Copilot Space.", + "items": { + "$ref": "#/components/schemas/copilot-space-collaborator" + } + } + } + }, + "examples": { + "default": { + "value": { + "collaborators": [ + { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "User", + "role": "reader", + "login": "github-user", + "id": 67890, + "node_id": "MDQ6VXNlcjY3ODkw", + "avatar_url": "https://github.com/images/error/other_user.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github-user", + "html_url": "https://github.com/github-user", + "followers_url": "https://api.github.com/users/github-user/followers", + "following_url": "https://api.github.com/users/github-user/following{/other_user}", + "gists_url": "https://api.github.com/users/github-user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github-user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github-user/subscriptions", + "organizations_url": "https://api.github.com/users/github-user/orgs", + "repos_url": "https://api.github.com/users/github-user/repos", + "events_url": "https://api.github.com/users/github-user/events{/privacy}", + "received_events_url": "https://api.github.com/users/github-user/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "GitHub User", + "company": null, + "blog": "", + "location": null, + "email": null, + "hireable": null, + "bio": null, + "twitter_username": null, + "public_repos": 5, + "public_gists": 0, + "followers": 10, + "following": 5, + "created_at": "2010-01-14T04:33:35Z", + "updated_at": "2010-01-14T04:33:35Z" + } + ] + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + }, + "post": { + "summary": "Add a collaborator to a Copilot Space for a user", + "description": "Adds a collaborator to a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nTeam collaborators are not supported for user-owned Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/add-collaborator-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "actor_type", + "actor_identifier", + "role" + ], + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User", + "Team" + ], + "description": "The type of actor (must be `User` for user-owned spaces; `Team` will be rejected)." + }, + "actor_identifier": { + "type": "string", + "description": "The username of the collaborator. The numeric user ID is also accepted." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role to grant to the collaborator." + } + } + }, + "examples": { + "default": { + "value": { + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-collaborator" + }, + "examples": { + "default": { + "value": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { + "put": { + "summary": "Set a collaborator role for a Copilot Space for a user", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-collaborator-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "The type of actor (must be `User` for user-owned spaces; `Team` will be rejected).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username of the collaborator. The numeric user ID is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "role" + ], + "properties": { + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The new role to grant to the collaborator. Use `no_access` to remove the collaborator." + } + } + }, + "examples": { + "default": { + "value": { + "role": "admin" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-collaborator" + }, + "examples": { + "default": { + "value": { + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + } + } + } + } + }, + "204": { + "description": "Response when `role` is `no_access` and the collaborator was removed." + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + }, + "delete": { + "summary": "Remove a collaborator from a Copilot Space for a user", + "description": "Removes a collaborator from a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/remove-collaborator-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "The type of actor (must be `User` for user-owned spaces; `Team` will be rejected).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username of the collaborator. The numeric user ID is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}/resources": { + "get": { + "summary": "List resources for a Copilot Space for a user", + "description": "Lists all resources attached to a specific Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-resources-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "$ref": "#/components/schemas/copilot-space-resource" + } + } + } + }, + "examples": { + "default": { + "value": { + "resources": [ + { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + ] + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" + } + }, + "post": { + "summary": "Create a resource for a Copilot Space for a user", + "description": "Creates a new resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/create-resource-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "resource_type", + "metadata" + ], + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ], + "description": "The type of resource to create." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata.", + "additionalProperties": true + } + } + }, + "examples": { + "free_text": { + "value": { + "resource_type": "free_text", + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + } + } + }, + "repository": { + "value": { + "resource_type": "repository", + "metadata": { + "repository_id": 42 + } + } + }, + "github_file": { + "value": { + "resource_type": "github_file", + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Resource created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "200": { + "description": "Duplicate github_file resource already exists", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "github_file", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}": { + "get": { + "summary": "Get a resource for a Copilot Space for a user", + "description": "Gets a specific resource attached to a Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/get-resource-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" + } + }, + "put": { + "summary": "Set a resource for a Copilot Space for a user", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-resource-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "Updated resource-specific metadata.", + "additionalProperties": true + } + } + }, + "examples": { + "default": { + "value": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" + } + }, + "delete": { + "summary": "Delete a resource from a Copilot Space for a user", + "description": "Deletes a resource from a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/delete-resource-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" + } + } + }, "/users/{username}/docker/conflicts": { "get": { "summary": "Get list of conflicting packages during Docker migration for user", @@ -105909,7 +108991,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -115573,6 +118655,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } }, "required": [ @@ -117510,6 +120596,394 @@ "key" ] }, + "copilot-space": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { + "anyOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/organization-simple" + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "$ref": "#/components/schemas/simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + }, + "copilot-space-collaborator": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + }, + "copilot-space-resource": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, "copilot-organization-seat-breakdown": { "title": "Copilot Seat Breakdown", "description": "The breakdown of Copilot Business seats for the organization.", @@ -127712,6 +131186,14 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether the repository has opted in to the immutable OIDC subject claim format. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim. If not set at the repository level, falls back to the organization-level setting.", + "type": "boolean" + }, + "sub_claim_prefix": { + "description": "The current `sub` claim prefix for this repository.", + "type": "string" } }, "required": [ @@ -302532,12 +306014,298 @@ "cpus": 4 }, "prebuild": false, - "devcontainer_path": ".devcontainer/devcontainer.json", + "devcontainer_path": ".devcontainer/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", + "recent_folders": [] + }, + { + "id": 1, + "name": "monalisa-octocat-hello-world-3f89ada1j3", + "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "billable_owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer/foobar/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop", + "recent_folders": [] + }, + { + "id": 1, + "name": "monalisa-octocat-hello-world-f8adfad99a", + "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "billable_owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", "git_status": { "ahead": 0, "behind": 0, @@ -302547,183 +306315,141 @@ }, "location": "WestUs2", "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", - "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", - "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", + "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", "recent_folders": [] + } + ] + } + }, + "repo-codespaces-secret-paginated": { + "value": { + "total_count": 2, + "secrets": [ + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" }, { - "id": 1, - "name": "monalisa-octocat-hello-world-3f89ada1j3", - "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", + "name": "GIST_ID", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z", + "visibility": "all" + } + ] + } + }, + "codespaces-public-key": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + }, + "repo-codespaces-secret": { + "value": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" + } + }, + "copilot-spaces-organization-list": { + "summary": "Example response for listing organization copilot spaces", + "value": { + "spaces": [ + { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", "owner": { - "login": "octocat", + "login": "octo-org", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" }, - "billable_owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", "type": "User", - "site_admin": false - }, - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 - }, - "prebuild": false, - "devcontainer_path": ".devcontainer/foobar/devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" + "site_admin": true }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", - "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start", - "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop", - "recent_folders": [] + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3" }, { - "id": 1, - "name": "monalisa-octocat-hello-world-f8adfad99a", - "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", + "id": 85, + "number": 4, + "name": "Development Resources", + "description": "Shared development documentation and resources", "owner": { - "login": "octocat", + "login": "octo-org", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" }, - "billable_owner": { + "creator": { "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", + "id": 3, + "node_id": "MDQ6VXNlcjM=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", @@ -302740,141 +306466,92 @@ "type": "User", "site_admin": false }, - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 - }, - "prebuild": false, - "devcontainer_path": ".devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" - }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", - "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", - "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", - "recent_folders": [] + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/4", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/4" } ] } }, - "repo-codespaces-secret-paginated": { + "copilot-space-organization": { + "summary": "Example response for an organization copilot space", "value": { - "total_count": 2, - "secrets": [ + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } }, { - "name": "GIST_ID", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z", - "visibility": "all" + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } } ] } }, - "codespaces-public-key": { - "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - } - }, - "repo-codespaces-secret": { - "value": { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" - } - }, "copilot-organization-details": { "value": { "seat_breakdown": { @@ -326035,6 +329712,186 @@ } } }, + "copilot-spaces-user-list": { + "summary": "Example response for listing user copilot spaces", + "value": { + "spaces": [ + { + "id": 42, + "number": 1, + "name": "Personal Research Space", + "description": "My personal space for research and development", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/1", + "api_url": "https://api.github.com/user/1/copilot-spaces/1" + }, + { + "id": 43, + "number": 2, + "name": "Learning Space", + "description": "Space for learning new technologies", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-17T08:20:00Z", + "updated_at": "2023-02-17T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/2", + "api_url": "https://api.github.com/user/1/copilot-spaces/2" + } + ] + } + }, + "copilot-space-user": { + "summary": "Example response for a user copilot space", + "value": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + } + }, "user-events-items": { "value": [ { diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index 7110b44bfd..3901c917c6 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -73,10 +73,15 @@ tags: description: Interact with GitHub Teams. - name: users description: Interact with and view information about users and also current user. +- name: code-quality + description: Insights into reliability, maintainability, and efficiency of your + codebase. - name: codespaces description: Endpoints to manage Codespaces using the REST API. - name: copilot description: Endpoints to manage Copilot using the REST API. +- name: copilot-spaces + description: Endpoints to manage Copilot Spaces using the REST API. - name: security-advisories description: Manage security advisories. - name: interactions @@ -2731,9 +2736,9 @@ paths: put: summary: Set the coding agent policy for an enterprise description: |- - Sets the policy for Copilot coding agent usage across an enterprise. + Sets the policy for Copilot cloud agent usage across an enterprise. - Enterprise owners can configure whether Copilot coding agent is enabled for all + Enterprise owners can configure whether Copilot cloud agent is enabled for all organizations, disabled for all organizations, configured by individual organization admins, or enabled for selected organizations only. @@ -2758,7 +2763,7 @@ paths: properties: policy_state: type: string - description: The policy state for Copilot coding agent in the enterprise. + description: The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`. enum: @@ -2786,7 +2791,7 @@ paths: post: summary: Add organizations to the enterprise coding agent policy description: |- - Enables Copilot coding agent for the specified organizations within the enterprise. + Enables Copilot cloud agent for the specified organizations within the enterprise. The enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before using this endpoint. Organizations can be specified by login or matched via custom properties. @@ -2805,7 +2810,7 @@ paths: parameters: - "$ref": "#/components/parameters/enterprise" requestBody: - description: The organizations to enable Copilot coding agent for + description: The organizations to enable Copilot cloud agent for required: true content: application/json: @@ -2815,7 +2820,7 @@ paths: organizations: type: array description: List of organization logins within the enterprise to - enable Copilot coding agent for. + enable Copilot cloud agent for. items: type: string custom_properties: @@ -2863,7 +2868,7 @@ paths: delete: summary: Remove organizations from the enterprise coding agent policy description: |- - Disables Copilot coding agent for the specified organizations within the enterprise. + Disables Copilot cloud agent for the specified organizations within the enterprise. The enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before using this endpoint. Organizations can be specified by login or matched via custom properties. @@ -2882,7 +2887,7 @@ paths: parameters: - "$ref": "#/components/parameters/enterprise" requestBody: - description: The organizations to disable Copilot coding agent for + description: The organizations to disable Copilot cloud agent for required: true content: application/json: @@ -2892,7 +2897,7 @@ paths: organizations: type: array description: List of organization logins within the enterprise to - disable Copilot coding agent for. + disable Copilot cloud agent for. items: type: string custom_properties: @@ -7777,6 +7782,12 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the name-based + format. + type: boolean examples: default: "$ref": "#/components/examples/oidc-custom-sub" @@ -13658,6 +13669,1185 @@ paths: enabledForGitHubApps: false category: codespaces subcategory: organization-secrets + "/orgs/{org}/copilot-spaces": + get: + summary: List organization Copilot Spaces + description: |- + Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces. + + Only Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-organization-copilot-spaces + parameters: + - "$ref": "#/components/parameters/org" + - name: per_page + description: The number of results per page (max 100). + in: query + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: before + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + in: query + schema: + type: string + - name: after + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. + in: query + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - spaces + properties: + spaces: + type: array + description: The list of Copilot Spaces on this page of results. + items: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-spaces-organization-list" + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + post: + summary: Create an organization Copilot Space + description: |- + Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization. + + Organization members with appropriate permissions can create Copilot Spaces to be shared within their organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - Team Planning Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Organization space for team planning and coordination + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Help the team with planning and coordination tasks + base_role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: |- + The base role that determines default permissions for organization members. + - `no_access`: No default access (default) + - `reader`: Organization members can read the space + - `writer`: Organization members can read and edit the space + - `admin`: Organization members have full admin access to the space + default: no_access + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + required: + - name + examples: + default: + value: + name: Team Planning Space + description: Organization space for team planning and coordination + general_instructions: Help the team with planning and coordination + tasks + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 123456 + file_path: docs/planning.md + - resource_type: free_text + metadata: + name: Team Guidelines + text: Our team follows agile methodology and holds daily standups + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-space-organization" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + "/orgs/{org}/copilot-spaces/{space_number}": + get: + summary: Get an organization Copilot Space + description: |- + Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space. + + Internal Spaces require the authenticated user to be a member of the organization or have been granted read permissions. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-space-organization" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + put: + summary: Set an organization Copilot Space + description: |- + Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization. + + Organization members with appropriate permissions can update Copilot Spaces owned by their organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - Updated Team Planning Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Updated organization space for team planning and coordination + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Updated instructions to help the team with planning and coordination + tasks + base_role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: |- + The base role that determines default permissions for organization members. Changing this field requires admin permissions. + - `no_access`: No default access (default) + - `reader`: Organization members can read the space + - `writer`: Organization members can read and edit the space + - `admin`: Organization members have full admin access to the space + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + examples: + default: + value: + name: Updated Team Planning Space + description: Updated organization space for team planning and coordination + general_instructions: Updated instructions to help the team with + planning and coordination tasks + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 123456 + file_path: docs/updated-planning.md + - id: 789 + _destroy: true + - id: 456 + resource_type: free_text + metadata: + name: Updated Team Guidelines + text: Our updated team follows agile methodology and holds daily + standups + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-space-organization" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + delete: + summary: Delete an organization Copilot Space + description: |- + Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization. + + **Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations. + + Organization members with appropriate permissions can delete Copilot Spaces owned by their organization. + + OAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '204': + description: The Copilot Space has been successfully deleted. + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + "/orgs/{org}/copilot-spaces/{space_number}/collaborators": + get: + summary: List collaborators for an organization Copilot Space + description: |- + Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators. + + Each collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list. + + **Note:** Team collaborators listed here are teams that are defined in the organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-collaborators-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - collaborators + properties: + collaborators: + type: array + description: The list of collaborators for this Copilot Space. + items: + "$ref": "#/components/schemas/copilot-space-collaborator" + examples: + default: + value: + collaborators: + - actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + - actor_type: Team + role: reader + id: 67890 + node_id: MDQ6VGVhbTY3ODkw + url: https://api.github.com/teams/67890 + html_url: https://github.com/orgs/octo-org/teams/developers + name: Developers + slug: developers + description: Team of developers + privacy: closed + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/67890/members{/member} + repositories_url: https://api.github.com/teams/67890/repos + parent: + created_at: '2017-07-14T16:53:42Z' + updated_at: '2017-08-17T12:37:15Z' + organization: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + post: + summary: Add a collaborator to an organization Copilot Space + description: |- + Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. + + **Note:** When adding users as collaborators, they must already be members of the organization. + When adding teams as collaborators, they must be defined in the organization. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/add-collaborator-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - actor_type + - actor_identifier + - role + properties: + actor_type: + type: string + enum: + - User + - Team + description: The type of actor (user or team). + actor_identifier: + type: string + description: The username (for users) or team slug (for teams). + The numeric ID of a user or team is also accepted. + role: + type: string + enum: + - reader + - writer + - admin + description: The role to grant to the collaborator. + examples: + user: + value: + actor_type: User + actor_identifier: octocat + role: writer + team: + value: + actor_type: Team + actor_identifier: developers + role: reader + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-collaborator" + examples: + user: + value: + actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + team: + value: + actor_type: Team + role: reader + id: 67890 + node_id: MDQ6VGVhbTY3ODkw + url: https://api.github.com/teams/67890 + html_url: https://github.com/orgs/octo-org/teams/developers + name: Developers + slug: developers + type: Team + description: Team of developers + privacy: closed + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/67890/members{/member} + repositories_url: https://api.github.com/teams/67890/repos + parent: + organization_id: 1 + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": + put: + summary: Set a collaborator role for an organization Copilot Space + description: |- + Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-collaborator-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (user or team). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username (for users) or team slug (for teams). The numeric + ID of a user or team is also accepted. + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - role + properties: + role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: The new role to grant to the collaborator. Use `no_access` + to remove the collaborator. + examples: + default: + value: + role: admin + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-collaborator" + examples: + user: + value: + actor_type: User + role: admin + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + team: + value: + actor_type: Team + role: admin + id: 67890 + node_id: MDQ6VGVhbTY3ODkw + url: https://api.github.com/teams/67890 + html_url: https://github.com/orgs/octo-org/teams/developers + name: Developers + slug: developers + type: Team + description: Team of developers + privacy: closed + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/67890/members{/member} + repositories_url: https://api.github.com/teams/67890/repos + parent: + organization_id: 1 + '204': + description: Response when `role` is `no_access` and the collaborator was + removed. + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + delete: + summary: Remove a collaborator from an organization Copilot Space + description: |- + Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/remove-collaborator-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (user or team). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username (for users) or team slug (for teams). The numeric + ID of a user or team is also accepted. + in: path + required: true + schema: + type: string + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + "/orgs/{org}/copilot-spaces/{space_number}/resources": + get: + summary: List resources for an organization Copilot Space + description: |- + Lists all resources attached to a specific Copilot Space owned by an organization. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-resources-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - resources + properties: + resources: + type: array + description: The list of resources attached to this Copilot Space. + items: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + resources: + - id: 1 + resource_type: repository + copilot_chat_attachment_id: + metadata: + repository_id: 42 + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + - id: 2 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + post: + summary: Create a resource for an organization Copilot Space + description: |- + Creates a new resource in a specific Copilot Space owned by an organization. + The authenticated user must have write permissions on the space. + + The following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`. + The `uploaded_text_file` and `media_content` types are not supported via this endpoint. + + For `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - resource_type + - metadata + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + description: The type of resource to create. + metadata: + type: object + description: Resource-specific metadata. + additionalProperties: true + examples: + free_text: + value: + resource_type: free_text + metadata: + name: notes.txt + text: Some helpful notes + repository: + value: + resource_type: repository + metadata: + repository_id: 42 + github_file: + value: + resource_type: github_file + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + responses: + '201': + description: Resource created + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '200': + description: Duplicate github_file resource already exists + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: github_file + copilot_chat_attachment_id: + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": + get: + summary: Get a resource for an organization Copilot Space + description: |- + Gets a specific resource attached to a Copilot Space owned by an organization. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + put: + summary: Set a resource for an organization Copilot Space + description: |- + Updates the metadata of a resource in a specific Copilot Space owned by an organization. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + description: Updated resource-specific metadata. + additionalProperties: true + examples: + default: + value: + metadata: + name: updated-notes.txt + text: Updated content + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: updated-notes.txt + text: Updated content + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T12:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + delete: + summary: Delete a resource from an organization Copilot Space + description: |- + Deletes a resource from a specific Copilot Space owned by an organization. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources "/orgs/{org}/copilot/billing": get: summary: Get Copilot seat information and settings for an organization @@ -14104,15 +15294,15 @@ paths: subcategory: copilot-user-management "/orgs/{org}/copilot/coding-agent/permissions": get: - summary: Get Copilot coding agent permissions for an organization + summary: Get Copilot cloud agent permissions for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Gets information about which repositories in an organization have been enabled - or disabled for the Copilot coding agent. + or disabled for the Copilot cloud agent. - Organization owners can configure whether Copilot coding agent is enabled for + Organization owners can configure whether Copilot cloud agent is enabled for all repositories, selected repositories, or no repositories owned by organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -14121,7 +15311,7 @@ paths: operationId: copilot/get-copilot-coding-agent-permissions-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-cloud-agent-permissions-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: @@ -14135,7 +15325,7 @@ paths: enabled_repositories: type: string description: The policy for which repositories can use Copilot - coding agent. Can be one of `all`, `selected`, or `none`. + cloud agent. Can be one of `all`, `selected`, or `none`. enum: - all - selected @@ -14174,14 +15364,14 @@ paths: category: copilot subcategory: copilot-coding-agent-management put: - summary: Set Copilot coding agent permissions for an organization + summary: Set Copilot cloud agent permissions for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. - Sets the policy for which repositories in an organization can use Copilot coding agent. + Sets the policy for which repositories in an organization can use Copilot cloud agent. - Organization owners can configure whether Copilot coding agent is enabled for + Organization owners can configure whether Copilot cloud agent is enabled for all repositories, selected repositories, or no repositories owned by the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -14190,7 +15380,7 @@ paths: operationId: copilot/set-copilot-coding-agent-permissions-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-cloud-agent-permissions-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -14202,7 +15392,7 @@ paths: properties: enabled_repositories: type: string - description: The policy for which repositories can use Copilot coding + description: The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`. enum: - all @@ -14234,12 +15424,12 @@ paths: subcategory: copilot-coding-agent-management "/orgs/{org}/copilot/coding-agent/permissions/repositories": get: - summary: List repositories enabled for Copilot coding agent in an organization + summary: List repositories enabled for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists the selected repositories that are enabled for Copilot coding agent in an organization. + Lists the selected repositories that are enabled for Copilot cloud agent in an organization. Organization owners can use this endpoint when the coding agent repository policy is set to `selected` to see which repositories have been enabled. @@ -14250,7 +15440,7 @@ paths: operationId: copilot/list-copilot-coding-agent-selected-repositories-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-cloud-agent-in-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" @@ -14291,13 +15481,13 @@ paths: category: copilot subcategory: copilot-coding-agent-management put: - summary: Set selected repositories for Copilot coding agent in an organization + summary: Set selected repositories for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. - Replaces the list of selected repositories that are enabled for Copilot coding - agent in an organization. This method can only be called when the coding agent + Replaces the list of selected repositories that are enabled for Copilot cloud + agent in an organization. This method can only be called when the cloud agent repository policy is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -14306,7 +15496,7 @@ paths: operationId: copilot/set-copilot-coding-agent-selected-repositories-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-cloud-agent-in-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -14317,7 +15507,7 @@ paths: type: object properties: selected_repository_ids: - description: List of repository IDs to enable for Copilot coding + description: List of repository IDs to enable for Copilot cloud agent. type: array items: @@ -14353,14 +15543,14 @@ paths: subcategory: copilot-coding-agent-management "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}": put: - summary: Enable a repository for Copilot coding agent in an organization + summary: Enable a repository for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Adds a repository to the list of selected repositories enabled for Copilot - coding agent in an organization. This method can only be called when the - coding agent repository policy is set to `selected`. + cloud agent in an organization. This method can only be called when the + cloud agent repository policy is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -14368,7 +15558,7 @@ paths: operationId: copilot/enable-copilot-coding-agent-for-repository-in-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-cloud-agent-in-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/repository-id" @@ -14393,14 +15583,14 @@ paths: category: copilot subcategory: copilot-coding-agent-management delete: - summary: Disable a repository for Copilot coding agent in an organization + summary: Disable a repository for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Removes a repository from the list of selected repositories enabled for Copilot - coding agent in an organization. This method can only be called when the - coding agent repository policy is set to `selected`. + cloud agent in an organization. This method can only be called when the + cloud agent repository policy is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint. tags: @@ -14408,7 +15598,7 @@ paths: operationId: copilot/disable-copilot-coding-agent-for-repository-in-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-cloud-agent-in-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/repository-id" @@ -24731,6 +25921,11 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for this repository. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. + type: boolean examples: default: value: @@ -47239,6 +48434,16 @@ paths: "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" assignee: "$ref": "#/components/schemas/secret-scanning-alert-assignee" + validity: + type: + - string + - 'null' + enum: + - active + - inactive + - + description: Sets the validity of the secret scanning alert. Can + be `active`, `inactive`, or `null` to clear the override. anyOf: - required: - state @@ -47277,7 +48482,8 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment, - or assignee does not have write access to the repository + assignee does not have write access to the repository, or the requested + validity change could not be applied to this alert '503': "$ref": "#/components/responses/service_unavailable" x-github: @@ -55351,6 +56557,1138 @@ paths: enabledForGitHubApps: true category: users subcategory: attestations + "/users/{username}/copilot-spaces": + get: + summary: List Copilot Spaces for a user + description: |- + Lists Copilot Spaces owned by a user. The authenticated user must have read access to the user's Copilot Spaces. + + Only Spaces that are readable by the authenticated user are returned. This includes the user's own spaces, and public user spaces when accessing another user's spaces. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-copilot-spaces-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: per_page + description: The number of results per page (max 100). + in: query + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: before + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + in: query + schema: + type: string + - name: after + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. + in: query + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - spaces + properties: + spaces: + type: array + description: The list of Copilot Spaces on this page of results. + items: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-spaces-user-list" + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + post: + summary: Create a Copilot Space for a user + description: |- + Creates a new Copilot Space owned by a user. Only the authenticated user can create spaces for their own account. + + Users can create personal Copilot Spaces for their individual use. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - My Development Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Personal space for development assistance + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Help me with React development patterns and best practices + base_role: + type: string + enum: + - reader + - no_access + description: |- + The base role that determines default permissions for the space. + - `no_access`: No default access (default) + - `reader`: Makes the space publicly readable + Note: User spaces do not support writer or admin base roles. + default: no_access + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + required: + - name + examples: + default: + value: + name: My Development Space + description: Personal space for development assistance + general_instructions: Help me with React development patterns and + best practices + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 789012 + file_path: src/components/App.js + - resource_type: free_text + metadata: + name: Development Notes + text: Focus on clean code principles and modern React patterns + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-space-user" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + "/users/{username}/copilot-spaces/{space_number}": + get: + summary: Get a Copilot Space for a user + description: |- + Gets details about a specific Copilot Space owned by a user. The authenticated user must have read access to the Space. + + Private user spaces require the authenticated user to be the owner of the space. + Public user spaces are accessible to any authenticated user. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-space-user" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + put: + summary: Set a Copilot Space for a user + description: |- + Updates a Copilot Space owned by a user. Only the authenticated user can update spaces for their own account. + + Users can update their personal Copilot Spaces. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - Updated Development Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Updated personal space for development assistance + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Updated instructions to help me with React development patterns + and best practices + base_role: + type: string + enum: + - reader + - no_access + description: |- + The base role that determines default permissions for the space. Changing this field requires admin permissions. + - `no_access`: No default access (default) + - `reader`: Makes the space publicly readable + Note: User spaces do not support writer or admin base roles. + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + examples: + default: + value: + name: Updated Development Space + description: Updated personal space for development assistance + general_instructions: Updated instructions to help me with React + development patterns and best practices + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 789012 + file_path: src/components/UpdatedApp.js + - id: 123 + _destroy: true + - id: 456 + resource_type: free_text + metadata: + name: Updated Development Notes + text: Updated focus on clean code principles and modern React + patterns + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-space-user" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + delete: + summary: Delete a Copilot Space for a user + description: |- + Deletes a Copilot Space owned by a user. The authenticated user must be the owner of the space. + + **Warning:** This action is permanent and cannot be undone. Deleting a space will remove all associated resources and configurations. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '204': + description: The Copilot Space has been successfully deleted. + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + "/users/{username}/copilot-spaces/{space_number}/collaborators": + get: + summary: List collaborators for a Copilot Space for a user + description: |- + Lists all collaborators for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + Each collaborator entry specifies which user has access to the space and at what level (reader, writer, or admin). The space owner is excluded from this list. + + Team collaborators are not supported for user-owned Copilot Spaces. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-collaborators-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - collaborators + properties: + collaborators: + type: array + description: The list of collaborators for this Copilot Space. + items: + "$ref": "#/components/schemas/copilot-space-collaborator" + examples: + default: + value: + collaborators: + - actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + - actor_type: User + role: reader + login: github-user + id: 67890 + node_id: MDQ6VXNlcjY3ODkw + avatar_url: https://github.com/images/error/other_user.gif + gravatar_id: '' + url: https://api.github.com/users/github-user + html_url: https://github.com/github-user + followers_url: https://api.github.com/users/github-user/followers + following_url: https://api.github.com/users/github-user/following{/other_user} + gists_url: https://api.github.com/users/github-user/gists{/gist_id} + starred_url: https://api.github.com/users/github-user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github-user/subscriptions + organizations_url: https://api.github.com/users/github-user/orgs + repos_url: https://api.github.com/users/github-user/repos + events_url: https://api.github.com/users/github-user/events{/privacy} + received_events_url: https://api.github.com/users/github-user/received_events + type: User + user_view_type: public + site_admin: false + name: GitHub User + company: + blog: '' + location: + email: + hireable: + bio: + twitter_username: + public_repos: 5 + public_gists: 0 + followers: 10 + following: 5 + created_at: '2010-01-14T04:33:35Z' + updated_at: '2010-01-14T04:33:35Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + post: + summary: Add a collaborator to a Copilot Space for a user + description: |- + Adds a collaborator to a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + Team collaborators are not supported for user-owned Copilot Spaces. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/add-collaborator-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - actor_type + - actor_identifier + - role + properties: + actor_type: + type: string + enum: + - User + - Team + description: The type of actor (must be `User` for user-owned spaces; + `Team` will be rejected). + actor_identifier: + type: string + description: The username of the collaborator. The numeric user + ID is also accepted. + role: + type: string + enum: + - reader + - writer + - admin + description: The role to grant to the collaborator. + examples: + default: + value: + actor_type: User + actor_identifier: octocat + role: writer + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-collaborator" + examples: + default: + value: + actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": + put: + summary: Set a collaborator role for a Copilot Space for a user + description: |- + Updates the role of a collaborator for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-collaborator-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (must be `User` for user-owned spaces; `Team` + will be rejected). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username of the collaborator. The numeric user ID is also + accepted. + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - role + properties: + role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: The new role to grant to the collaborator. Use `no_access` + to remove the collaborator. + examples: + default: + value: + role: admin + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-collaborator" + examples: + default: + value: + actor_type: User + role: admin + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + '204': + description: Response when `role` is `no_access` and the collaborator was + removed. + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + delete: + summary: Remove a collaborator from a Copilot Space for a user + description: |- + Removes a collaborator from a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/remove-collaborator-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (must be `User` for user-owned spaces; `Team` + will be rejected). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username of the collaborator. The numeric user ID is also + accepted. + in: path + required: true + schema: + type: string + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + "/users/{username}/copilot-spaces/{space_number}/resources": + get: + summary: List resources for a Copilot Space for a user + description: |- + Lists all resources attached to a specific Copilot Space owned by a user. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-resources-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - resources + properties: + resources: + type: array + description: The list of resources attached to this Copilot Space. + items: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + resources: + - id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + post: + summary: Create a resource for a Copilot Space for a user + description: |- + Creates a new resource in a specific Copilot Space owned by a user. + The authenticated user must have write permissions on the space. + + The following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`. + The `uploaded_text_file` and `media_content` types are not supported via this endpoint. + + For `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status. + + OAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - resource_type + - metadata + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + description: The type of resource to create. + metadata: + type: object + description: Resource-specific metadata. + additionalProperties: true + examples: + free_text: + value: + resource_type: free_text + metadata: + name: notes.txt + text: Some helpful notes + repository: + value: + resource_type: repository + metadata: + repository_id: 42 + github_file: + value: + resource_type: github_file + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + responses: + '201': + description: Resource created + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '200': + description: Duplicate github_file resource already exists + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: github_file + copilot_chat_attachment_id: + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}": + get: + summary: Get a resource for a Copilot Space for a user + description: |- + Gets a specific resource attached to a Copilot Space owned by a user. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + put: + summary: Set a resource for a Copilot Space for a user + description: |- + Updates the metadata of a resource in a specific Copilot Space owned by a user. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + description: Updated resource-specific metadata. + additionalProperties: true + examples: + default: + value: + metadata: + name: updated-notes.txt + text: Updated content + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: updated-notes.txt + text: Updated content + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T12:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + delete: + summary: Delete a resource from a Copilot Space for a user + description: |- + Deletes a resource from a specific Copilot Space owned by a user. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources "/users/{username}/docker/conflicts": get: summary: Get list of conflicting packages during Docker migration for user @@ -76459,7 +78797,7 @@ components: organization_copilot_agent_settings: type: string description: The level of permission to grant the access token to view and - manage Copilot coding agent settings for an organization. + manage Copilot cloud agent settings for an organization. enum: - read - write @@ -83667,6 +86005,11 @@ components: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim format + for the organization. When `true`, new OIDC tokens will use a stable, + repository-ID-based `sub` claim instead of the name-based format. + type: boolean required: - include_claim_keys empty-object: @@ -85152,6 +87495,296 @@ components: required: - key_id - key + copilot-space: + title: Space + description: A GitHub Copilot Space represents an interactive AI workspace where + users can ask questions and get assistance. + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the space. + examples: + - 42 + number: + type: integer + description: The number that identifies the space within its owner. + examples: + - 1 + name: + type: string + description: The display name of the space. + examples: + - My Development Space + description: + type: + - string + - 'null' + description: A description of the space. + examples: + - A space for discussing React development patterns + general_instructions: + type: + - string + - 'null' + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Help with React development patterns and best practices + base_role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: |- + The base role that determines default permissions. + - `no_access`: No default access + - `reader`: Default read permissions + - `writer`: Default write permissions (organization spaces only) + - `admin`: Default admin permissions (organization spaces only) + examples: + - no_access + owner: + anyOf: + - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/organization-simple" + description: The user or organization that owns this space. + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + description: The date and time the space was created. + examples: + - '2023-01-01T00:00:00Z' + updated_at: + type: string + format: date-time + description: The date and time the space was last updated. + examples: + - '2023-01-01T12:00:00Z' + html_url: + type: string + format: uri + description: The HTML URL of the space. + examples: + - https://github.com/copilot/spaces/octo-org/5 + api_url: + type: string + format: uri + description: The API URL of the space. + examples: + - https://api.github.com/organizations/1/copilot-spaces/5 + resources_attributes: + type: array + description: Resources attached to the space. + items: + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the resource. + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + copilot_chat_attachment_id: + type: + - integer + - 'null' + format: int64 + description: The unique identifier of the chat attachment for uploaded + files or media content. + created_at: + type: string + format: date-time + description: The date and time the resource was created. + updated_at: + type: string + format: date-time + description: The date and time the resource was last updated. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + copilot_chat_attachment_id: + type: integer + description: Chat attachment ID for uploaded files or media. + media_type: + type: string + description: Media type for media content resources. + url: + type: string + description: URL for media content resources. + height: + type: integer + description: Height for media content resources. + width: + type: integer + description: Width for media content resources. + required: + - id + - number + - name + - base_role + - owner + - creator + - created_at + - updated_at + - html_url + - api_url + additionalProperties: false + copilot-space-collaborator: + title: Copilot Space Collaborator + description: A collaborator (user or team) of a Copilot Space + type: object + anyOf: + - allOf: + - "$ref": "#/components/schemas/simple-user" + - type: object + properties: + actor_type: + type: string + enum: + - User + description: The collaborator actor type. + role: + type: string + enum: + - reader + - writer + - admin + description: The role granted to the collaborator + required: + - actor_type + - role + - type: object + properties: + actor_type: + type: string + enum: + - Team + description: The collaborator actor type. + role: + type: string + enum: + - reader + - writer + - admin + description: The role granted to the collaborator + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + type: + type: string + enum: + - Team + description: + type: + - string + - 'null' + privacy: + type: string + notification_setting: + type: string + url: + type: string + format: uri + html_url: + type: string + format: uri + members_url: + type: string + repositories_url: + type: string + format: uri + organization_id: + type: integer + parent: + type: + - 'null' + required: + - actor_type + - role + - id + - node_id + - name + - slug + - type + copilot-space-resource: + title: Copilot Space Resource + description: A resource attached to a Copilot Space. + type: object + properties: + id: + type: integer + description: The unique identifier of the resource. + resource_type: + type: string + description: The type of the resource. + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + copilot_chat_attachment_id: + type: + - integer + - 'null' + description: The ID of the associated chat attachment, if any. + metadata: + type: object + description: Resource-specific metadata. The keys and values depend on the + resource type. + additionalProperties: true + created_at: + type: string + format: date-time + description: The date and time the resource was created. + updated_at: + type: string + format: date-time + description: The date and time the resource was last updated. + required: + - id + - resource_type + - metadata + - created_at + - updated_at copilot-organization-seat-breakdown: title: Copilot Seat Breakdown description: The breakdown of Copilot Business seats for the organization. @@ -92753,6 +95386,15 @@ components: type: array items: type: string + use_immutable_subject: + description: Whether the repository has opted in to the immutable OIDC subject + claim format. When `true`, OIDC tokens will use a stable, repository-ID-based + `sub` claim. If not set at the repository level, falls back to the organization-level + setting. + type: boolean + sub_claim_prefix: + description: The current `sub` claim prefix for this repository. + type: string required: - use_default actions-secret: @@ -223510,6 +226152,180 @@ components: created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' visibility: all + copilot-spaces-organization-list: + summary: Example response for listing organization copilot spaces + value: + spaces: + - id: 84 + number: 3 + name: Team Planning Space + description: Organization space for team planning and coordination + owner: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + gravatar_id: '' + name: octo-org + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: octo-org + html_url: https://github.com/octo-org + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + creator: + login: defunkt + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://github.com/images/error/defunkt_happy.gif + gravatar_id: '' + url: https://api.github.com/users/defunkt + html_url: https://github.com/defunkt + followers_url: https://api.github.com/users/defunkt/followers + following_url: https://api.github.com/users/defunkt/following{/other_user} + gists_url: https://api.github.com/users/defunkt/gists{/gist_id} + starred_url: https://api.github.com/users/defunkt/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/defunkt/subscriptions + organizations_url: https://api.github.com/users/defunkt/orgs + repos_url: https://api.github.com/users/defunkt/repos + events_url: https://api.github.com/users/defunkt/events{/privacy} + received_events_url: https://api.github.com/users/defunkt/received_events + type: User + site_admin: true + created_at: '2023-02-15T08:30:00Z' + updated_at: '2023-02-15T14:45:00Z' + html_url: https://github.com/copilot/spaces/octo-org/3 + api_url: https://api.github.com/organizations/1/copilot-spaces/3 + - id: 85 + number: 4 + name: Development Resources + description: Shared development documentation and resources + owner: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + gravatar_id: '' + name: octo-org + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: octo-org + html_url: https://github.com/octo-org + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + creator: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-16T10:15:00Z' + updated_at: '2023-02-16T16:30:00Z' + html_url: https://github.com/copilot/spaces/octo-org/4 + api_url: https://api.github.com/organizations/1/copilot-spaces/4 + copilot-space-organization: + summary: Example response for an organization copilot space + value: + id: 84 + number: 3 + name: Team Planning Space + description: Organization space for team planning and coordination + general_instructions: Help the team with agile planning, sprint coordination, + and project management best practices + owner: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + gravatar_id: '' + name: octo-org + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: octo-org + html_url: https://github.com/octo-org + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + creator: + login: defunkt + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://github.com/images/error/defunkt_happy.gif + gravatar_id: '' + url: https://api.github.com/users/defunkt + html_url: https://github.com/defunkt + followers_url: https://api.github.com/users/defunkt/followers + following_url: https://api.github.com/users/defunkt/following{/other_user} + gists_url: https://api.github.com/users/defunkt/gists{/gist_id} + starred_url: https://api.github.com/users/defunkt/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/defunkt/subscriptions + organizations_url: https://api.github.com/users/defunkt/orgs + repos_url: https://api.github.com/users/defunkt/repos + events_url: https://api.github.com/users/defunkt/events{/privacy} + received_events_url: https://api.github.com/users/defunkt/received_events + type: User + site_admin: true + created_at: '2023-02-15T08:30:00Z' + updated_at: '2023-02-15T14:45:00Z' + html_url: https://github.com/copilot/spaces/octo-org/3 + api_url: https://api.github.com/organizations/1/copilot-spaces/3 + base_role: no_access + resources_attributes: + - id: 123 + resource_type: github_file + metadata: + repository_id: 456 + file_path: docs/planning.md + - id: 124 + resource_type: free_text + metadata: + name: Team Guidelines + text: Our team follows agile methodology copilot-organization-details: value: seat_breakdown: @@ -243413,6 +246229,165 @@ components: space: 976562499 collaborators: 0 private_repos: 9999 + copilot-spaces-user-list: + summary: Example response for listing user copilot spaces + value: + spaces: + - id: 42 + number: 1 + name: Personal Research Space + description: My personal space for research and development + owner: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-16T10:15:00Z' + updated_at: '2023-02-16T16:30:00Z' + html_url: https://github.com/copilot/spaces/octocat/1 + api_url: https://api.github.com/user/1/copilot-spaces/1 + - id: 43 + number: 2 + name: Learning Space + description: Space for learning new technologies + owner: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-17T08:20:00Z' + updated_at: '2023-02-17T14:45:00Z' + html_url: https://github.com/copilot/spaces/octocat/2 + api_url: https://api.github.com/user/1/copilot-spaces/2 + copilot-space-user: + summary: Example response for a user copilot space + value: + id: 42 + number: 5 + name: My Development Space + description: Personal space for React development patterns + general_instructions: Focus on React functional components, hooks, and modern + development patterns + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-15T08:30:00Z' + updated_at: '2023-02-15T14:45:00Z' + html_url: https://github.com/copilot/spaces/octocat/5 + api_url: https://api.github.com/user/1/copilot-spaces/5 + base_role: no_access + resources_attributes: + - id: 789 + resource_type: github_file + metadata: + repository_id: 1234 + file_path: src/components/App.tsx + - id: 790 + resource_type: free_text + metadata: + name: React Best Practices + text: Use functional components with hooks user-events-items: value: - id: '22249084947' diff --git a/descriptions-next/api.github.com/api.github.com.2026-03-10.json b/descriptions-next/api.github.com/api.github.com.2026-03-10.json index 54b6fd9178..30dfb1c042 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.json @@ -136,6 +136,10 @@ "name": "users", "description": "Interact with and view information about users and also current user." }, + { + "name": "code-quality", + "description": "Insights into reliability, maintainability, and efficiency of your codebase." + }, { "name": "codespaces", "description": "Endpoints to manage Codespaces using the REST API." @@ -144,6 +148,10 @@ "name": "copilot", "description": "Endpoints to manage Copilot using the REST API." }, + { + "name": "copilot-spaces", + "description": "Endpoints to manage Copilot Spaces using the REST API." + }, { "name": "security-advisories", "description": "Manage security advisories." @@ -3781,7 +3789,7 @@ "/enterprises/{enterprise}/copilot/policies/coding_agent": { "put": { "summary": "Set the coding agent policy for an enterprise", - "description": "Sets the policy for Copilot coding agent usage across an enterprise.\n\nEnterprise owners can configure whether Copilot coding agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.\n\nOnly enterprise owners can set the coding agent policy for their enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "description": "Sets the policy for Copilot cloud agent usage across an enterprise.\n\nEnterprise owners can configure whether Copilot cloud agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.\n\nOnly enterprise owners can set the coding agent policy for their enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -3805,7 +3813,7 @@ "properties": { "policy_state": { "type": "string", - "description": "The policy state for Copilot coding agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.", + "description": "The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.", "enum": [ "enabled_for_all_orgs", "disabled_for_all_orgs", @@ -3847,7 +3855,7 @@ "/enterprises/{enterprise}/copilot/policies/coding_agent/organizations": { "post": { "summary": "Add organizations to the enterprise coding agent policy", - "description": "Enables Copilot coding agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can add organizations to the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "description": "Enables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can add organizations to the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -3862,7 +3870,7 @@ } ], "requestBody": { - "description": "The organizations to enable Copilot coding agent for", + "description": "The organizations to enable Copilot cloud agent for", "required": true, "content": { "application/json": { @@ -3871,7 +3879,7 @@ "properties": { "organizations": { "type": "array", - "description": "List of organization logins within the enterprise to enable Copilot coding agent for.", + "description": "List of organization logins within the enterprise to enable Copilot cloud agent for.", "items": { "type": "string" } @@ -3941,7 +3949,7 @@ }, "delete": { "summary": "Remove organizations from the enterprise coding agent policy", - "description": "Disables Copilot coding agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can remove organizations from the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "description": "Disables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can remove organizations from the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -3956,7 +3964,7 @@ } ], "requestBody": { - "description": "The organizations to disable Copilot coding agent for", + "description": "The organizations to disable Copilot cloud agent for", "required": true, "content": { "application/json": { @@ -3965,7 +3973,7 @@ "properties": { "organizations": { "type": "array", - "description": "List of organization logins within the enterprise to disable Copilot coding agent for.", + "description": "List of organization logins within the enterprise to disable Copilot cloud agent for.", "items": { "type": "string" } @@ -10848,6 +10856,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } } }, @@ -18749,6 +18761,1561 @@ } } }, + "/orgs/{org}/copilot-spaces": { + "get": { + "summary": "List organization Copilot Spaces", + "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-organization-copilot-spaces" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "spaces" + ], + "properties": { + "spaces": { + "type": "array", + "description": "The list of Copilot Spaces on this page of results.", + "items": { + "$ref": "#/components/schemas/copilot-space" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-spaces-organization-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "post": { + "summary": "Create an organization Copilot Space", + "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/create-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "Team Planning Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Organization space for team planning and coordination" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help the team with planning and coordination tasks" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions for organization members.\n- `no_access`: No default access (default)\n- `reader`: Organization members can read the space\n- `writer`: Organization members can read and edit the space\n- `admin`: Organization members have full admin access to the space", + "default": "no_access" + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/planning.md" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology and holds daily standups" + } + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-space-organization" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + } + }, + "/orgs/{org}/copilot-spaces/{space_number}": { + "get": { + "summary": "Get an organization Copilot Space", + "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/get-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-space-organization" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "put": { + "summary": "Set an organization Copilot Space", + "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "Updated Team Planning Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Updated organization space for team planning and coordination" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Updated instructions to help the team with planning and coordination tasks" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions for organization members. Changing this field requires admin permissions.\n- `no_access`: No default access (default)\n- `reader`: Organization members can read the space\n- `writer`: Organization members can read and edit the space\n- `admin`: Organization members have full admin access to the space" + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "Updated Team Planning Space", + "description": "Updated organization space for team planning and coordination", + "general_instructions": "Updated instructions to help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/updated-planning.md" + } + }, + { + "id": 789, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Team Guidelines", + "text": "Our updated team follows agile methodology and holds daily standups" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-space-organization" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "delete": { + "summary": "Delete an organization Copilot Space", + "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/delete-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "The Copilot Space has been successfully deleted." + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + } + }, + "/orgs/{org}/copilot-spaces/{space_number}/collaborators": { + "get": { + "summary": "List collaborators for an organization Copilot Space", + "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-collaborators-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "collaborators" + ], + "properties": { + "collaborators": { + "type": "array", + "description": "The list of collaborators for this Copilot Space.", + "items": { + "$ref": "#/components/schemas/copilot-space-collaborator" + } + } + } + }, + "examples": { + "default": { + "value": { + "collaborators": [ + { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + } + ] + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + }, + "post": { + "summary": "Add a collaborator to an organization Copilot Space", + "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/add-collaborator-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "actor_type", + "actor_identifier", + "role" + ], + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User", + "Team" + ], + "description": "The type of actor (user or team)." + }, + "actor_identifier": { + "type": "string", + "description": "The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role to grant to the collaborator." + } + } + }, + "examples": { + "user": { + "value": { + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" + } + }, + "team": { + "value": { + "actor_type": "Team", + "actor_identifier": "developers", + "role": "reader" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-collaborator" + }, + "examples": { + "user": { + "value": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "team": { + "value": { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + } + }, + "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { + "put": { + "summary": "Set a collaborator role for an organization Copilot Space", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-collaborator-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "The type of actor (user or team).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "role" + ], + "properties": { + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The new role to grant to the collaborator. Use `no_access` to remove the collaborator." + } + } + }, + "examples": { + "default": { + "value": { + "role": "admin" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-collaborator" + }, + "examples": { + "user": { + "value": { + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "team": { + "value": { + "actor_type": "Team", + "role": "admin", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 + } + } + } + } + } + }, + "204": { + "description": "Response when `role` is `no_access` and the collaborator was removed." + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + }, + "delete": { + "summary": "Remove a collaborator from an organization Copilot Space", + "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/remove-collaborator-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "The type of actor (user or team).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + } + }, + "/orgs/{org}/copilot-spaces/{space_number}/resources": { + "get": { + "summary": "List resources for an organization Copilot Space", + "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-resources-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "$ref": "#/components/schemas/copilot-space-resource" + } + } + } + }, + "examples": { + "default": { + "value": { + "resources": [ + { + "id": 1, + "resource_type": "repository", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42 + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + { + "id": 2, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + ] + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "resources" + } + }, + "post": { + "summary": "Create a resource for an organization Copilot Space", + "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/create-resource-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "resource_type", + "metadata" + ], + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ], + "description": "The type of resource to create." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata.", + "additionalProperties": true + } + } + }, + "examples": { + "free_text": { + "value": { + "resource_type": "free_text", + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + } + } + }, + "repository": { + "value": { + "resource_type": "repository", + "metadata": { + "repository_id": 42 + } + } + }, + "github_file": { + "value": { + "resource_type": "github_file", + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Resource created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "200": { + "description": "Duplicate github_file resource already exists", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "github_file", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "resources" + } + } + }, + "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": { + "get": { + "summary": "Get a resource for an organization Copilot Space", + "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/get-resource-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "resources" + } + }, + "put": { + "summary": "Set a resource for an organization Copilot Space", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-resource-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "Updated resource-specific metadata.", + "additionalProperties": true + } + } + }, + "examples": { + "default": { + "value": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "resources" + } + }, + "delete": { + "summary": "Delete a resource from an organization Copilot Space", + "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/delete-resource-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "resources" + } + } + }, "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", @@ -19295,15 +20862,15 @@ }, "/orgs/{org}/copilot/coding-agent/permissions": { "get": { - "summary": "Get Copilot coding agent permissions for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about which repositories in an organization have been enabled\nor disabled for the Copilot coding agent.\n\nOrganization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Get Copilot cloud agent permissions for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about which repositories in an organization have been enabled\nor disabled for the Copilot cloud agent.\n\nOrganization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/get-copilot-coding-agent-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-cloud-agent-permissions-for-an-organization" }, "parameters": [ { @@ -19320,7 +20887,7 @@ "properties": { "enabled_repositories": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", "selected", @@ -19381,15 +20948,15 @@ } }, "put": { - "summary": "Set Copilot coding agent permissions for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets the policy for which repositories in an organization can use Copilot coding agent.\n\nOrganization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Set Copilot cloud agent permissions for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets the policy for which repositories in an organization can use Copilot cloud agent.\n\nOrganization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/set-copilot-coding-agent-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-cloud-agent-permissions-for-an-organization" }, "parameters": [ { @@ -19405,7 +20972,7 @@ "properties": { "enabled_repositories": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", "selected", @@ -19457,15 +21024,15 @@ }, "/orgs/{org}/copilot/coding-agent/permissions/repositories": { "get": { - "summary": "List repositories enabled for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists the selected repositories that are enabled for Copilot coding agent in an organization.\n\nOrganization owners can use this endpoint when the coding agent repository policy\nis set to `selected` to see which repositories have been enabled.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "List repositories enabled for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists the selected repositories that are enabled for Copilot cloud agent in an organization.\n\nOrganization owners can use this endpoint when the coding agent repository policy\nis set to `selected` to see which repositories have been enabled.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/list-copilot-coding-agent-selected-repositories-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -19533,15 +21100,15 @@ } }, "put": { - "summary": "Set selected repositories for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReplaces the list of selected repositories that are enabled for Copilot coding\nagent in an organization. This method can only be called when the coding agent\nrepository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Set selected repositories for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReplaces the list of selected repositories that are enabled for Copilot cloud\nagent in an organization. This method can only be called when the cloud agent\nrepository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/set-copilot-coding-agent-selected-repositories-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -19556,7 +21123,7 @@ "type": "object", "properties": { "selected_repository_ids": { - "description": "List of repository IDs to enable for Copilot coding agent.", + "description": "List of repository IDs to enable for Copilot cloud agent.", "type": "array", "items": { "type": "integer", @@ -19614,15 +21181,15 @@ }, "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}": { "put": { - "summary": "Enable a repository for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nAdds a repository to the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Enable a repository for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nAdds a repository to the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/enable-copilot-coding-agent-for-repository-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -19663,15 +21230,15 @@ } }, "delete": { - "summary": "Disable a repository for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemoves a repository from the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint.", + "summary": "Disable a repository for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemoves a repository from the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/disable-copilot-coding-agent-for-repository-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -33885,6 +35452,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for this repository. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim.", + "type": "boolean" } } }, @@ -37425,7 +38996,7 @@ ], "responses": { "200": { - "description": "Response including the workflow run ID and URLs when `return_run_details` parameter is `true`.", + "description": "Response including the workflow run ID and URLs.", "content": { "application/json": { "schema": { @@ -64935,6 +66506,18 @@ }, "assignee": { "$ref": "#/components/schemas/secret-scanning-alert-assignee" + }, + "validity": { + "type": [ + "string", + "null" + ], + "enum": [ + "active", + "inactive", + null + ], + "description": "Sets the validity of the secret scanning alert. Can be `active`, `inactive`, or `null` to clear the override." } }, "anyOf": [ @@ -65001,7 +66584,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" + "description": "State does not match the resolution or resolution comment, assignee does not have write access to the repository, or the requested validity change could not be applied to this alert" }, "503": { "$ref": "#/components/responses/service_unavailable" @@ -76118,6 +77701,1505 @@ } } }, + "/users/{username}/copilot-spaces": { + "get": { + "summary": "List Copilot Spaces for a user", + "description": "Lists Copilot Spaces owned by a user. The authenticated user must have read access to the user's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes the user's own spaces, and public user spaces when accessing another user's spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-copilot-spaces-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "spaces" + ], + "properties": { + "spaces": { + "type": "array", + "description": "The list of Copilot Spaces on this page of results.", + "items": { + "$ref": "#/components/schemas/copilot-space" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-spaces-user-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "post": { + "summary": "Create a Copilot Space for a user", + "description": "Creates a new Copilot Space owned by a user. Only the authenticated user can create spaces for their own account.\n\nUsers can create personal Copilot Spaces for their individual use.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/create-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Personal space for development assistance" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help me with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "no_access" + ], + "description": "The base role that determines default permissions for the space.\n- `no_access`: No default access (default)\n- `reader`: Makes the space publicly readable\nNote: User spaces do not support writer or admin base roles.", + "default": "no_access" + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "My Development Space", + "description": "Personal space for development assistance", + "general_instructions": "Help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/App.js" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Development Notes", + "text": "Focus on clean code principles and modern React patterns" + } + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-space-user" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}": { + "get": { + "summary": "Get a Copilot Space for a user", + "description": "Gets details about a specific Copilot Space owned by a user. The authenticated user must have read access to the Space.\n\nPrivate user spaces require the authenticated user to be the owner of the space.\nPublic user spaces are accessible to any authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/get-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-space-user" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "put": { + "summary": "Set a Copilot Space for a user", + "description": "Updates a Copilot Space owned by a user. Only the authenticated user can update spaces for their own account.\n\nUsers can update their personal Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "Updated Development Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Updated personal space for development assistance" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Updated instructions to help me with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "no_access" + ], + "description": "The base role that determines default permissions for the space. Changing this field requires admin permissions.\n- `no_access`: No default access (default)\n- `reader`: Makes the space publicly readable\nNote: User spaces do not support writer or admin base roles." + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "Updated Development Space", + "description": "Updated personal space for development assistance", + "general_instructions": "Updated instructions to help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/UpdatedApp.js" + } + }, + { + "id": 123, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Development Notes", + "text": "Updated focus on clean code principles and modern React patterns" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-space-user" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "delete": { + "summary": "Delete a Copilot Space for a user", + "description": "Deletes a Copilot Space owned by a user. The authenticated user must be the owner of the space.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a space will remove all associated resources and configurations.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/delete-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "The Copilot Space has been successfully deleted." + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}/collaborators": { + "get": { + "summary": "List collaborators for a Copilot Space for a user", + "description": "Lists all collaborators for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nEach collaborator entry specifies which user has access to the space and at what level (reader, writer, or admin). The space owner is excluded from this list.\n\nTeam collaborators are not supported for user-owned Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-collaborators-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "collaborators" + ], + "properties": { + "collaborators": { + "type": "array", + "description": "The list of collaborators for this Copilot Space.", + "items": { + "$ref": "#/components/schemas/copilot-space-collaborator" + } + } + } + }, + "examples": { + "default": { + "value": { + "collaborators": [ + { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "User", + "role": "reader", + "login": "github-user", + "id": 67890, + "node_id": "MDQ6VXNlcjY3ODkw", + "avatar_url": "https://github.com/images/error/other_user.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github-user", + "html_url": "https://github.com/github-user", + "followers_url": "https://api.github.com/users/github-user/followers", + "following_url": "https://api.github.com/users/github-user/following{/other_user}", + "gists_url": "https://api.github.com/users/github-user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github-user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github-user/subscriptions", + "organizations_url": "https://api.github.com/users/github-user/orgs", + "repos_url": "https://api.github.com/users/github-user/repos", + "events_url": "https://api.github.com/users/github-user/events{/privacy}", + "received_events_url": "https://api.github.com/users/github-user/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "GitHub User", + "company": null, + "blog": "", + "location": null, + "email": null, + "hireable": null, + "bio": null, + "twitter_username": null, + "public_repos": 5, + "public_gists": 0, + "followers": 10, + "following": 5, + "created_at": "2010-01-14T04:33:35Z", + "updated_at": "2010-01-14T04:33:35Z" + } + ] + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + }, + "post": { + "summary": "Add a collaborator to a Copilot Space for a user", + "description": "Adds a collaborator to a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nTeam collaborators are not supported for user-owned Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/add-collaborator-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "actor_type", + "actor_identifier", + "role" + ], + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User", + "Team" + ], + "description": "The type of actor (must be `User` for user-owned spaces; `Team` will be rejected)." + }, + "actor_identifier": { + "type": "string", + "description": "The username of the collaborator. The numeric user ID is also accepted." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role to grant to the collaborator." + } + } + }, + "examples": { + "default": { + "value": { + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-collaborator" + }, + "examples": { + "default": { + "value": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { + "put": { + "summary": "Set a collaborator role for a Copilot Space for a user", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-collaborator-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "The type of actor (must be `User` for user-owned spaces; `Team` will be rejected).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username of the collaborator. The numeric user ID is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "role" + ], + "properties": { + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The new role to grant to the collaborator. Use `no_access` to remove the collaborator." + } + } + }, + "examples": { + "default": { + "value": { + "role": "admin" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-collaborator" + }, + "examples": { + "default": { + "value": { + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + } + } + } + } + }, + "204": { + "description": "Response when `role` is `no_access` and the collaborator was removed." + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + }, + "delete": { + "summary": "Remove a collaborator from a Copilot Space for a user", + "description": "Removes a collaborator from a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/remove-collaborator-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "The type of actor (must be `User` for user-owned spaces; `Team` will be rejected).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username of the collaborator. The numeric user ID is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}/resources": { + "get": { + "summary": "List resources for a Copilot Space for a user", + "description": "Lists all resources attached to a specific Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-resources-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "$ref": "#/components/schemas/copilot-space-resource" + } + } + } + }, + "examples": { + "default": { + "value": { + "resources": [ + { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + ] + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" + } + }, + "post": { + "summary": "Create a resource for a Copilot Space for a user", + "description": "Creates a new resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/create-resource-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "resource_type", + "metadata" + ], + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ], + "description": "The type of resource to create." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata.", + "additionalProperties": true + } + } + }, + "examples": { + "free_text": { + "value": { + "resource_type": "free_text", + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + } + } + }, + "repository": { + "value": { + "resource_type": "repository", + "metadata": { + "repository_id": 42 + } + } + }, + "github_file": { + "value": { + "resource_type": "github_file", + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Resource created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "200": { + "description": "Duplicate github_file resource already exists", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "github_file", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}": { + "get": { + "summary": "Get a resource for a Copilot Space for a user", + "description": "Gets a specific resource attached to a Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/get-resource-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" + } + }, + "put": { + "summary": "Set a resource for a Copilot Space for a user", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-resource-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "Updated resource-specific metadata.", + "additionalProperties": true + } + } + }, + "examples": { + "default": { + "value": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" + } + }, + "delete": { + "summary": "Delete a resource from a Copilot Space for a user", + "description": "Deletes a resource from a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/delete-resource-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" + } + } + }, "/users/{username}/docker/conflicts": { "get": { "summary": "Get list of conflicting packages during Docker migration for user", @@ -105748,7 +108830,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -115009,6 +118091,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } }, "required": [ @@ -116946,6 +120032,394 @@ "key" ] }, + "copilot-space": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { + "anyOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/organization-simple" + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "$ref": "#/components/schemas/simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + }, + "copilot-space-collaborator": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + }, + "copilot-space-resource": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, "copilot-organization-seat-breakdown": { "title": "Copilot Seat Breakdown", "description": "The breakdown of Copilot Business seats for the organization.", @@ -127072,6 +130546,14 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether the repository has opted in to the immutable OIDC subject claim format. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim. If not set at the repository level, falls back to the organization-level setting.", + "type": "boolean" + }, + "sub_claim_prefix": { + "description": "The current `sub` claim prefix for this repository.", + "type": "string" } }, "required": [ @@ -301691,12 +305173,298 @@ "cpus": 4 }, "prebuild": false, - "devcontainer_path": ".devcontainer/devcontainer.json", + "devcontainer_path": ".devcontainer/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", + "recent_folders": [] + }, + { + "id": 1, + "name": "monalisa-octocat-hello-world-3f89ada1j3", + "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "billable_owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer/foobar/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop", + "recent_folders": [] + }, + { + "id": 1, + "name": "monalisa-octocat-hello-world-f8adfad99a", + "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "billable_owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", "git_status": { "ahead": 0, "behind": 0, @@ -301706,183 +305474,141 @@ }, "location": "WestUs2", "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", - "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", - "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", + "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", "recent_folders": [] + } + ] + } + }, + "repo-codespaces-secret-paginated": { + "value": { + "total_count": 2, + "secrets": [ + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" }, { - "id": 1, - "name": "monalisa-octocat-hello-world-3f89ada1j3", - "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", + "name": "GIST_ID", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z", + "visibility": "all" + } + ] + } + }, + "codespaces-public-key": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + }, + "repo-codespaces-secret": { + "value": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" + } + }, + "copilot-spaces-organization-list": { + "summary": "Example response for listing organization copilot spaces", + "value": { + "spaces": [ + { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", "owner": { - "login": "octocat", + "login": "octo-org", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" }, - "billable_owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", "type": "User", - "site_admin": false - }, - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 - }, - "prebuild": false, - "devcontainer_path": ".devcontainer/foobar/devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" + "site_admin": true }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", - "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start", - "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop", - "recent_folders": [] + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3" }, { - "id": 1, - "name": "monalisa-octocat-hello-world-f8adfad99a", - "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", + "id": 85, + "number": 4, + "name": "Development Resources", + "description": "Shared development documentation and resources", "owner": { - "login": "octocat", + "login": "octo-org", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" }, - "billable_owner": { + "creator": { "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", + "id": 3, + "node_id": "MDQ6VXNlcjM=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", @@ -301899,141 +305625,92 @@ "type": "User", "site_admin": false }, - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 - }, - "prebuild": false, - "devcontainer_path": ".devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" - }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", - "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", - "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", - "recent_folders": [] + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/4", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/4" } ] } }, - "repo-codespaces-secret-paginated": { + "copilot-space-organization": { + "summary": "Example response for an organization copilot space", "value": { - "total_count": 2, - "secrets": [ + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } }, { - "name": "GIST_ID", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z", - "visibility": "all" + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } } ] } }, - "codespaces-public-key": { - "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - } - }, - "repo-codespaces-secret": { - "value": { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" - } - }, "copilot-organization-details": { "value": { "seat_breakdown": { @@ -325095,6 +328772,186 @@ } } }, + "copilot-spaces-user-list": { + "summary": "Example response for listing user copilot spaces", + "value": { + "spaces": [ + { + "id": 42, + "number": 1, + "name": "Personal Research Space", + "description": "My personal space for research and development", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/1", + "api_url": "https://api.github.com/user/1/copilot-spaces/1" + }, + { + "id": 43, + "number": 2, + "name": "Learning Space", + "description": "Space for learning new technologies", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-17T08:20:00Z", + "updated_at": "2023-02-17T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/2", + "api_url": "https://api.github.com/user/1/copilot-spaces/2" + } + ] + } + }, + "copilot-space-user": { + "summary": "Example response for a user copilot space", + "value": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + } + }, "user-events-items": { "value": [ { diff --git a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml index 16ab777d1b..6819017a16 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml @@ -73,10 +73,15 @@ tags: description: Interact with GitHub Teams. - name: users description: Interact with and view information about users and also current user. +- name: code-quality + description: Insights into reliability, maintainability, and efficiency of your + codebase. - name: codespaces description: Endpoints to manage Codespaces using the REST API. - name: copilot description: Endpoints to manage Copilot using the REST API. +- name: copilot-spaces + description: Endpoints to manage Copilot Spaces using the REST API. - name: security-advisories description: Manage security advisories. - name: interactions @@ -2731,9 +2736,9 @@ paths: put: summary: Set the coding agent policy for an enterprise description: |- - Sets the policy for Copilot coding agent usage across an enterprise. + Sets the policy for Copilot cloud agent usage across an enterprise. - Enterprise owners can configure whether Copilot coding agent is enabled for all + Enterprise owners can configure whether Copilot cloud agent is enabled for all organizations, disabled for all organizations, configured by individual organization admins, or enabled for selected organizations only. @@ -2758,7 +2763,7 @@ paths: properties: policy_state: type: string - description: The policy state for Copilot coding agent in the enterprise. + description: The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`. enum: @@ -2786,7 +2791,7 @@ paths: post: summary: Add organizations to the enterprise coding agent policy description: |- - Enables Copilot coding agent for the specified organizations within the enterprise. + Enables Copilot cloud agent for the specified organizations within the enterprise. The enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before using this endpoint. Organizations can be specified by login or matched via custom properties. @@ -2805,7 +2810,7 @@ paths: parameters: - "$ref": "#/components/parameters/enterprise" requestBody: - description: The organizations to enable Copilot coding agent for + description: The organizations to enable Copilot cloud agent for required: true content: application/json: @@ -2815,7 +2820,7 @@ paths: organizations: type: array description: List of organization logins within the enterprise to - enable Copilot coding agent for. + enable Copilot cloud agent for. items: type: string custom_properties: @@ -2863,7 +2868,7 @@ paths: delete: summary: Remove organizations from the enterprise coding agent policy description: |- - Disables Copilot coding agent for the specified organizations within the enterprise. + Disables Copilot cloud agent for the specified organizations within the enterprise. The enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before using this endpoint. Organizations can be specified by login or matched via custom properties. @@ -2882,7 +2887,7 @@ paths: parameters: - "$ref": "#/components/parameters/enterprise" requestBody: - description: The organizations to disable Copilot coding agent for + description: The organizations to disable Copilot cloud agent for required: true content: application/json: @@ -2892,7 +2897,7 @@ paths: organizations: type: array description: List of organization logins within the enterprise to - disable Copilot coding agent for. + disable Copilot cloud agent for. items: type: string custom_properties: @@ -7775,6 +7780,12 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the name-based + format. + type: boolean examples: default: "$ref": "#/components/examples/oidc-custom-sub" @@ -13624,6 +13635,1185 @@ paths: enabledForGitHubApps: false category: codespaces subcategory: organization-secrets + "/orgs/{org}/copilot-spaces": + get: + summary: List organization Copilot Spaces + description: |- + Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces. + + Only Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-organization-copilot-spaces + parameters: + - "$ref": "#/components/parameters/org" + - name: per_page + description: The number of results per page (max 100). + in: query + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: before + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + in: query + schema: + type: string + - name: after + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. + in: query + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - spaces + properties: + spaces: + type: array + description: The list of Copilot Spaces on this page of results. + items: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-spaces-organization-list" + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + post: + summary: Create an organization Copilot Space + description: |- + Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization. + + Organization members with appropriate permissions can create Copilot Spaces to be shared within their organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - Team Planning Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Organization space for team planning and coordination + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Help the team with planning and coordination tasks + base_role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: |- + The base role that determines default permissions for organization members. + - `no_access`: No default access (default) + - `reader`: Organization members can read the space + - `writer`: Organization members can read and edit the space + - `admin`: Organization members have full admin access to the space + default: no_access + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + required: + - name + examples: + default: + value: + name: Team Planning Space + description: Organization space for team planning and coordination + general_instructions: Help the team with planning and coordination + tasks + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 123456 + file_path: docs/planning.md + - resource_type: free_text + metadata: + name: Team Guidelines + text: Our team follows agile methodology and holds daily standups + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-space-organization" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + "/orgs/{org}/copilot-spaces/{space_number}": + get: + summary: Get an organization Copilot Space + description: |- + Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space. + + Internal Spaces require the authenticated user to be a member of the organization or have been granted read permissions. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-space-organization" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + put: + summary: Set an organization Copilot Space + description: |- + Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization. + + Organization members with appropriate permissions can update Copilot Spaces owned by their organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - Updated Team Planning Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Updated organization space for team planning and coordination + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Updated instructions to help the team with planning and coordination + tasks + base_role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: |- + The base role that determines default permissions for organization members. Changing this field requires admin permissions. + - `no_access`: No default access (default) + - `reader`: Organization members can read the space + - `writer`: Organization members can read and edit the space + - `admin`: Organization members have full admin access to the space + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + examples: + default: + value: + name: Updated Team Planning Space + description: Updated organization space for team planning and coordination + general_instructions: Updated instructions to help the team with + planning and coordination tasks + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 123456 + file_path: docs/updated-planning.md + - id: 789 + _destroy: true + - id: 456 + resource_type: free_text + metadata: + name: Updated Team Guidelines + text: Our updated team follows agile methodology and holds daily + standups + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-space-organization" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + delete: + summary: Delete an organization Copilot Space + description: |- + Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization. + + **Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations. + + Organization members with appropriate permissions can delete Copilot Spaces owned by their organization. + + OAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '204': + description: The Copilot Space has been successfully deleted. + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + "/orgs/{org}/copilot-spaces/{space_number}/collaborators": + get: + summary: List collaborators for an organization Copilot Space + description: |- + Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators. + + Each collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list. + + **Note:** Team collaborators listed here are teams that are defined in the organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-collaborators-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - collaborators + properties: + collaborators: + type: array + description: The list of collaborators for this Copilot Space. + items: + "$ref": "#/components/schemas/copilot-space-collaborator" + examples: + default: + value: + collaborators: + - actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + - actor_type: Team + role: reader + id: 67890 + node_id: MDQ6VGVhbTY3ODkw + url: https://api.github.com/teams/67890 + html_url: https://github.com/orgs/octo-org/teams/developers + name: Developers + slug: developers + description: Team of developers + privacy: closed + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/67890/members{/member} + repositories_url: https://api.github.com/teams/67890/repos + parent: + created_at: '2017-07-14T16:53:42Z' + updated_at: '2017-08-17T12:37:15Z' + organization: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + post: + summary: Add a collaborator to an organization Copilot Space + description: |- + Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. + + **Note:** When adding users as collaborators, they must already be members of the organization. + When adding teams as collaborators, they must be defined in the organization. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/add-collaborator-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - actor_type + - actor_identifier + - role + properties: + actor_type: + type: string + enum: + - User + - Team + description: The type of actor (user or team). + actor_identifier: + type: string + description: The username (for users) or team slug (for teams). + The numeric ID of a user or team is also accepted. + role: + type: string + enum: + - reader + - writer + - admin + description: The role to grant to the collaborator. + examples: + user: + value: + actor_type: User + actor_identifier: octocat + role: writer + team: + value: + actor_type: Team + actor_identifier: developers + role: reader + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-collaborator" + examples: + user: + value: + actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + team: + value: + actor_type: Team + role: reader + id: 67890 + node_id: MDQ6VGVhbTY3ODkw + url: https://api.github.com/teams/67890 + html_url: https://github.com/orgs/octo-org/teams/developers + name: Developers + slug: developers + type: Team + description: Team of developers + privacy: closed + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/67890/members{/member} + repositories_url: https://api.github.com/teams/67890/repos + parent: + organization_id: 1 + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": + put: + summary: Set a collaborator role for an organization Copilot Space + description: |- + Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-collaborator-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (user or team). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username (for users) or team slug (for teams). The numeric + ID of a user or team is also accepted. + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - role + properties: + role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: The new role to grant to the collaborator. Use `no_access` + to remove the collaborator. + examples: + default: + value: + role: admin + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-collaborator" + examples: + user: + value: + actor_type: User + role: admin + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + team: + value: + actor_type: Team + role: admin + id: 67890 + node_id: MDQ6VGVhbTY3ODkw + url: https://api.github.com/teams/67890 + html_url: https://github.com/orgs/octo-org/teams/developers + name: Developers + slug: developers + type: Team + description: Team of developers + privacy: closed + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/67890/members{/member} + repositories_url: https://api.github.com/teams/67890/repos + parent: + organization_id: 1 + '204': + description: Response when `role` is `no_access` and the collaborator was + removed. + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + delete: + summary: Remove a collaborator from an organization Copilot Space + description: |- + Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/remove-collaborator-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (user or team). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username (for users) or team slug (for teams). The numeric + ID of a user or team is also accepted. + in: path + required: true + schema: + type: string + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + "/orgs/{org}/copilot-spaces/{space_number}/resources": + get: + summary: List resources for an organization Copilot Space + description: |- + Lists all resources attached to a specific Copilot Space owned by an organization. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-resources-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - resources + properties: + resources: + type: array + description: The list of resources attached to this Copilot Space. + items: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + resources: + - id: 1 + resource_type: repository + copilot_chat_attachment_id: + metadata: + repository_id: 42 + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + - id: 2 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + post: + summary: Create a resource for an organization Copilot Space + description: |- + Creates a new resource in a specific Copilot Space owned by an organization. + The authenticated user must have write permissions on the space. + + The following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`. + The `uploaded_text_file` and `media_content` types are not supported via this endpoint. + + For `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - resource_type + - metadata + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + description: The type of resource to create. + metadata: + type: object + description: Resource-specific metadata. + additionalProperties: true + examples: + free_text: + value: + resource_type: free_text + metadata: + name: notes.txt + text: Some helpful notes + repository: + value: + resource_type: repository + metadata: + repository_id: 42 + github_file: + value: + resource_type: github_file + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + responses: + '201': + description: Resource created + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '200': + description: Duplicate github_file resource already exists + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: github_file + copilot_chat_attachment_id: + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": + get: + summary: Get a resource for an organization Copilot Space + description: |- + Gets a specific resource attached to a Copilot Space owned by an organization. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + put: + summary: Set a resource for an organization Copilot Space + description: |- + Updates the metadata of a resource in a specific Copilot Space owned by an organization. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + description: Updated resource-specific metadata. + additionalProperties: true + examples: + default: + value: + metadata: + name: updated-notes.txt + text: Updated content + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: updated-notes.txt + text: Updated content + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T12:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + delete: + summary: Delete a resource from an organization Copilot Space + description: |- + Deletes a resource from a specific Copilot Space owned by an organization. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources "/orgs/{org}/copilot/billing": get: summary: Get Copilot seat information and settings for an organization @@ -14070,15 +15260,15 @@ paths: subcategory: copilot-user-management "/orgs/{org}/copilot/coding-agent/permissions": get: - summary: Get Copilot coding agent permissions for an organization + summary: Get Copilot cloud agent permissions for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Gets information about which repositories in an organization have been enabled - or disabled for the Copilot coding agent. + or disabled for the Copilot cloud agent. - Organization owners can configure whether Copilot coding agent is enabled for + Organization owners can configure whether Copilot cloud agent is enabled for all repositories, selected repositories, or no repositories owned by organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -14087,7 +15277,7 @@ paths: operationId: copilot/get-copilot-coding-agent-permissions-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-cloud-agent-permissions-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: @@ -14101,7 +15291,7 @@ paths: enabled_repositories: type: string description: The policy for which repositories can use Copilot - coding agent. Can be one of `all`, `selected`, or `none`. + cloud agent. Can be one of `all`, `selected`, or `none`. enum: - all - selected @@ -14140,14 +15330,14 @@ paths: category: copilot subcategory: copilot-coding-agent-management put: - summary: Set Copilot coding agent permissions for an organization + summary: Set Copilot cloud agent permissions for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. - Sets the policy for which repositories in an organization can use Copilot coding agent. + Sets the policy for which repositories in an organization can use Copilot cloud agent. - Organization owners can configure whether Copilot coding agent is enabled for + Organization owners can configure whether Copilot cloud agent is enabled for all repositories, selected repositories, or no repositories owned by the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -14156,7 +15346,7 @@ paths: operationId: copilot/set-copilot-coding-agent-permissions-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-cloud-agent-permissions-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -14168,7 +15358,7 @@ paths: properties: enabled_repositories: type: string - description: The policy for which repositories can use Copilot coding + description: The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`. enum: - all @@ -14200,12 +15390,12 @@ paths: subcategory: copilot-coding-agent-management "/orgs/{org}/copilot/coding-agent/permissions/repositories": get: - summary: List repositories enabled for Copilot coding agent in an organization + summary: List repositories enabled for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists the selected repositories that are enabled for Copilot coding agent in an organization. + Lists the selected repositories that are enabled for Copilot cloud agent in an organization. Organization owners can use this endpoint when the coding agent repository policy is set to `selected` to see which repositories have been enabled. @@ -14216,7 +15406,7 @@ paths: operationId: copilot/list-copilot-coding-agent-selected-repositories-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-cloud-agent-in-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" @@ -14257,13 +15447,13 @@ paths: category: copilot subcategory: copilot-coding-agent-management put: - summary: Set selected repositories for Copilot coding agent in an organization + summary: Set selected repositories for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. - Replaces the list of selected repositories that are enabled for Copilot coding - agent in an organization. This method can only be called when the coding agent + Replaces the list of selected repositories that are enabled for Copilot cloud + agent in an organization. This method can only be called when the cloud agent repository policy is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -14272,7 +15462,7 @@ paths: operationId: copilot/set-copilot-coding-agent-selected-repositories-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-cloud-agent-in-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -14283,7 +15473,7 @@ paths: type: object properties: selected_repository_ids: - description: List of repository IDs to enable for Copilot coding + description: List of repository IDs to enable for Copilot cloud agent. type: array items: @@ -14319,14 +15509,14 @@ paths: subcategory: copilot-coding-agent-management "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}": put: - summary: Enable a repository for Copilot coding agent in an organization + summary: Enable a repository for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Adds a repository to the list of selected repositories enabled for Copilot - coding agent in an organization. This method can only be called when the - coding agent repository policy is set to `selected`. + cloud agent in an organization. This method can only be called when the + cloud agent repository policy is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -14334,7 +15524,7 @@ paths: operationId: copilot/enable-copilot-coding-agent-for-repository-in-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-cloud-agent-in-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/repository-id" @@ -14359,14 +15549,14 @@ paths: category: copilot subcategory: copilot-coding-agent-management delete: - summary: Disable a repository for Copilot coding agent in an organization + summary: Disable a repository for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Removes a repository from the list of selected repositories enabled for Copilot - coding agent in an organization. This method can only be called when the - coding agent repository policy is set to `selected`. + cloud agent in an organization. This method can only be called when the + cloud agent repository policy is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint. tags: @@ -14374,7 +15564,7 @@ paths: operationId: copilot/disable-copilot-coding-agent-for-repository-in-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-cloud-agent-in-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/repository-id" @@ -24693,6 +25883,11 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for this repository. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. + type: boolean examples: default: value: @@ -27191,8 +28386,7 @@ paths: - "$ref": "#/components/parameters/workflow-id" responses: '200': - description: Response including the workflow run ID and URLs when `return_run_details` - parameter is `true`. + description: Response including the workflow run ID and URLs. content: application/json: schema: @@ -47165,6 +48359,16 @@ paths: "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" assignee: "$ref": "#/components/schemas/secret-scanning-alert-assignee" + validity: + type: + - string + - 'null' + enum: + - active + - inactive + - + description: Sets the validity of the secret scanning alert. Can + be `active`, `inactive`, or `null` to clear the override. anyOf: - required: - state @@ -47203,7 +48407,8 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment, - or assignee does not have write access to the repository + assignee does not have write access to the repository, or the requested + validity change could not be applied to this alert '503': "$ref": "#/components/responses/service_unavailable" x-github: @@ -55251,6 +56456,1138 @@ paths: enabledForGitHubApps: true category: users subcategory: attestations + "/users/{username}/copilot-spaces": + get: + summary: List Copilot Spaces for a user + description: |- + Lists Copilot Spaces owned by a user. The authenticated user must have read access to the user's Copilot Spaces. + + Only Spaces that are readable by the authenticated user are returned. This includes the user's own spaces, and public user spaces when accessing another user's spaces. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-copilot-spaces-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: per_page + description: The number of results per page (max 100). + in: query + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: before + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + in: query + schema: + type: string + - name: after + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. + in: query + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - spaces + properties: + spaces: + type: array + description: The list of Copilot Spaces on this page of results. + items: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-spaces-user-list" + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + post: + summary: Create a Copilot Space for a user + description: |- + Creates a new Copilot Space owned by a user. Only the authenticated user can create spaces for their own account. + + Users can create personal Copilot Spaces for their individual use. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - My Development Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Personal space for development assistance + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Help me with React development patterns and best practices + base_role: + type: string + enum: + - reader + - no_access + description: |- + The base role that determines default permissions for the space. + - `no_access`: No default access (default) + - `reader`: Makes the space publicly readable + Note: User spaces do not support writer or admin base roles. + default: no_access + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + required: + - name + examples: + default: + value: + name: My Development Space + description: Personal space for development assistance + general_instructions: Help me with React development patterns and + best practices + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 789012 + file_path: src/components/App.js + - resource_type: free_text + metadata: + name: Development Notes + text: Focus on clean code principles and modern React patterns + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-space-user" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + "/users/{username}/copilot-spaces/{space_number}": + get: + summary: Get a Copilot Space for a user + description: |- + Gets details about a specific Copilot Space owned by a user. The authenticated user must have read access to the Space. + + Private user spaces require the authenticated user to be the owner of the space. + Public user spaces are accessible to any authenticated user. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-space-user" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + put: + summary: Set a Copilot Space for a user + description: |- + Updates a Copilot Space owned by a user. Only the authenticated user can update spaces for their own account. + + Users can update their personal Copilot Spaces. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - Updated Development Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Updated personal space for development assistance + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Updated instructions to help me with React development patterns + and best practices + base_role: + type: string + enum: + - reader + - no_access + description: |- + The base role that determines default permissions for the space. Changing this field requires admin permissions. + - `no_access`: No default access (default) + - `reader`: Makes the space publicly readable + Note: User spaces do not support writer or admin base roles. + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + examples: + default: + value: + name: Updated Development Space + description: Updated personal space for development assistance + general_instructions: Updated instructions to help me with React + development patterns and best practices + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 789012 + file_path: src/components/UpdatedApp.js + - id: 123 + _destroy: true + - id: 456 + resource_type: free_text + metadata: + name: Updated Development Notes + text: Updated focus on clean code principles and modern React + patterns + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-space-user" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + delete: + summary: Delete a Copilot Space for a user + description: |- + Deletes a Copilot Space owned by a user. The authenticated user must be the owner of the space. + + **Warning:** This action is permanent and cannot be undone. Deleting a space will remove all associated resources and configurations. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '204': + description: The Copilot Space has been successfully deleted. + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + "/users/{username}/copilot-spaces/{space_number}/collaborators": + get: + summary: List collaborators for a Copilot Space for a user + description: |- + Lists all collaborators for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + Each collaborator entry specifies which user has access to the space and at what level (reader, writer, or admin). The space owner is excluded from this list. + + Team collaborators are not supported for user-owned Copilot Spaces. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-collaborators-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - collaborators + properties: + collaborators: + type: array + description: The list of collaborators for this Copilot Space. + items: + "$ref": "#/components/schemas/copilot-space-collaborator" + examples: + default: + value: + collaborators: + - actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + - actor_type: User + role: reader + login: github-user + id: 67890 + node_id: MDQ6VXNlcjY3ODkw + avatar_url: https://github.com/images/error/other_user.gif + gravatar_id: '' + url: https://api.github.com/users/github-user + html_url: https://github.com/github-user + followers_url: https://api.github.com/users/github-user/followers + following_url: https://api.github.com/users/github-user/following{/other_user} + gists_url: https://api.github.com/users/github-user/gists{/gist_id} + starred_url: https://api.github.com/users/github-user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github-user/subscriptions + organizations_url: https://api.github.com/users/github-user/orgs + repos_url: https://api.github.com/users/github-user/repos + events_url: https://api.github.com/users/github-user/events{/privacy} + received_events_url: https://api.github.com/users/github-user/received_events + type: User + user_view_type: public + site_admin: false + name: GitHub User + company: + blog: '' + location: + email: + hireable: + bio: + twitter_username: + public_repos: 5 + public_gists: 0 + followers: 10 + following: 5 + created_at: '2010-01-14T04:33:35Z' + updated_at: '2010-01-14T04:33:35Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + post: + summary: Add a collaborator to a Copilot Space for a user + description: |- + Adds a collaborator to a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + Team collaborators are not supported for user-owned Copilot Spaces. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/add-collaborator-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - actor_type + - actor_identifier + - role + properties: + actor_type: + type: string + enum: + - User + - Team + description: The type of actor (must be `User` for user-owned spaces; + `Team` will be rejected). + actor_identifier: + type: string + description: The username of the collaborator. The numeric user + ID is also accepted. + role: + type: string + enum: + - reader + - writer + - admin + description: The role to grant to the collaborator. + examples: + default: + value: + actor_type: User + actor_identifier: octocat + role: writer + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-collaborator" + examples: + default: + value: + actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": + put: + summary: Set a collaborator role for a Copilot Space for a user + description: |- + Updates the role of a collaborator for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-collaborator-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (must be `User` for user-owned spaces; `Team` + will be rejected). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username of the collaborator. The numeric user ID is also + accepted. + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - role + properties: + role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: The new role to grant to the collaborator. Use `no_access` + to remove the collaborator. + examples: + default: + value: + role: admin + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-collaborator" + examples: + default: + value: + actor_type: User + role: admin + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + '204': + description: Response when `role` is `no_access` and the collaborator was + removed. + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + delete: + summary: Remove a collaborator from a Copilot Space for a user + description: |- + Removes a collaborator from a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/remove-collaborator-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (must be `User` for user-owned spaces; `Team` + will be rejected). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username of the collaborator. The numeric user ID is also + accepted. + in: path + required: true + schema: + type: string + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + "/users/{username}/copilot-spaces/{space_number}/resources": + get: + summary: List resources for a Copilot Space for a user + description: |- + Lists all resources attached to a specific Copilot Space owned by a user. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-resources-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - resources + properties: + resources: + type: array + description: The list of resources attached to this Copilot Space. + items: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + resources: + - id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + post: + summary: Create a resource for a Copilot Space for a user + description: |- + Creates a new resource in a specific Copilot Space owned by a user. + The authenticated user must have write permissions on the space. + + The following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`. + The `uploaded_text_file` and `media_content` types are not supported via this endpoint. + + For `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status. + + OAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - resource_type + - metadata + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + description: The type of resource to create. + metadata: + type: object + description: Resource-specific metadata. + additionalProperties: true + examples: + free_text: + value: + resource_type: free_text + metadata: + name: notes.txt + text: Some helpful notes + repository: + value: + resource_type: repository + metadata: + repository_id: 42 + github_file: + value: + resource_type: github_file + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + responses: + '201': + description: Resource created + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '200': + description: Duplicate github_file resource already exists + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: github_file + copilot_chat_attachment_id: + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}": + get: + summary: Get a resource for a Copilot Space for a user + description: |- + Gets a specific resource attached to a Copilot Space owned by a user. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + put: + summary: Set a resource for a Copilot Space for a user + description: |- + Updates the metadata of a resource in a specific Copilot Space owned by a user. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + description: Updated resource-specific metadata. + additionalProperties: true + examples: + default: + value: + metadata: + name: updated-notes.txt + text: Updated content + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: updated-notes.txt + text: Updated content + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T12:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + delete: + summary: Delete a resource from a Copilot Space for a user + description: |- + Deletes a resource from a specific Copilot Space owned by a user. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources "/users/{username}/docker/conflicts": get: summary: Get list of conflicting packages during Docker migration for user @@ -76329,7 +78666,7 @@ components: organization_copilot_agent_settings: type: string description: The level of permission to grant the access token to view and - manage Copilot coding agent settings for an organization. + manage Copilot cloud agent settings for an organization. enum: - read - write @@ -83249,6 +85586,11 @@ components: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim format + for the organization. When `true`, new OIDC tokens will use a stable, + repository-ID-based `sub` claim instead of the name-based format. + type: boolean required: - include_claim_keys empty-object: @@ -84734,6 +87076,296 @@ components: required: - key_id - key + copilot-space: + title: Space + description: A GitHub Copilot Space represents an interactive AI workspace where + users can ask questions and get assistance. + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the space. + examples: + - 42 + number: + type: integer + description: The number that identifies the space within its owner. + examples: + - 1 + name: + type: string + description: The display name of the space. + examples: + - My Development Space + description: + type: + - string + - 'null' + description: A description of the space. + examples: + - A space for discussing React development patterns + general_instructions: + type: + - string + - 'null' + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Help with React development patterns and best practices + base_role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: |- + The base role that determines default permissions. + - `no_access`: No default access + - `reader`: Default read permissions + - `writer`: Default write permissions (organization spaces only) + - `admin`: Default admin permissions (organization spaces only) + examples: + - no_access + owner: + anyOf: + - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/organization-simple" + description: The user or organization that owns this space. + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + description: The date and time the space was created. + examples: + - '2023-01-01T00:00:00Z' + updated_at: + type: string + format: date-time + description: The date and time the space was last updated. + examples: + - '2023-01-01T12:00:00Z' + html_url: + type: string + format: uri + description: The HTML URL of the space. + examples: + - https://github.com/copilot/spaces/octo-org/5 + api_url: + type: string + format: uri + description: The API URL of the space. + examples: + - https://api.github.com/organizations/1/copilot-spaces/5 + resources_attributes: + type: array + description: Resources attached to the space. + items: + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the resource. + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + copilot_chat_attachment_id: + type: + - integer + - 'null' + format: int64 + description: The unique identifier of the chat attachment for uploaded + files or media content. + created_at: + type: string + format: date-time + description: The date and time the resource was created. + updated_at: + type: string + format: date-time + description: The date and time the resource was last updated. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + copilot_chat_attachment_id: + type: integer + description: Chat attachment ID for uploaded files or media. + media_type: + type: string + description: Media type for media content resources. + url: + type: string + description: URL for media content resources. + height: + type: integer + description: Height for media content resources. + width: + type: integer + description: Width for media content resources. + required: + - id + - number + - name + - base_role + - owner + - creator + - created_at + - updated_at + - html_url + - api_url + additionalProperties: false + copilot-space-collaborator: + title: Copilot Space Collaborator + description: A collaborator (user or team) of a Copilot Space + type: object + anyOf: + - allOf: + - "$ref": "#/components/schemas/simple-user" + - type: object + properties: + actor_type: + type: string + enum: + - User + description: The collaborator actor type. + role: + type: string + enum: + - reader + - writer + - admin + description: The role granted to the collaborator + required: + - actor_type + - role + - type: object + properties: + actor_type: + type: string + enum: + - Team + description: The collaborator actor type. + role: + type: string + enum: + - reader + - writer + - admin + description: The role granted to the collaborator + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + type: + type: string + enum: + - Team + description: + type: + - string + - 'null' + privacy: + type: string + notification_setting: + type: string + url: + type: string + format: uri + html_url: + type: string + format: uri + members_url: + type: string + repositories_url: + type: string + format: uri + organization_id: + type: integer + parent: + type: + - 'null' + required: + - actor_type + - role + - id + - node_id + - name + - slug + - type + copilot-space-resource: + title: Copilot Space Resource + description: A resource attached to a Copilot Space. + type: object + properties: + id: + type: integer + description: The unique identifier of the resource. + resource_type: + type: string + description: The type of the resource. + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + copilot_chat_attachment_id: + type: + - integer + - 'null' + description: The ID of the associated chat attachment, if any. + metadata: + type: object + description: Resource-specific metadata. The keys and values depend on the + resource type. + additionalProperties: true + created_at: + type: string + format: date-time + description: The date and time the resource was created. + updated_at: + type: string + format: date-time + description: The date and time the resource was last updated. + required: + - id + - resource_type + - metadata + - created_at + - updated_at copilot-organization-seat-breakdown: title: Copilot Seat Breakdown description: The breakdown of Copilot Business seats for the organization. @@ -92283,6 +94915,15 @@ components: type: array items: type: string + use_immutable_subject: + description: Whether the repository has opted in to the immutable OIDC subject + claim format. When `true`, OIDC tokens will use a stable, repository-ID-based + `sub` claim. If not set at the repository level, falls back to the organization-level + setting. + type: boolean + sub_claim_prefix: + description: The current `sub` claim prefix for this repository. + type: string required: - use_default actions-secret: @@ -222816,6 +225457,180 @@ components: created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' visibility: all + copilot-spaces-organization-list: + summary: Example response for listing organization copilot spaces + value: + spaces: + - id: 84 + number: 3 + name: Team Planning Space + description: Organization space for team planning and coordination + owner: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + gravatar_id: '' + name: octo-org + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: octo-org + html_url: https://github.com/octo-org + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + creator: + login: defunkt + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://github.com/images/error/defunkt_happy.gif + gravatar_id: '' + url: https://api.github.com/users/defunkt + html_url: https://github.com/defunkt + followers_url: https://api.github.com/users/defunkt/followers + following_url: https://api.github.com/users/defunkt/following{/other_user} + gists_url: https://api.github.com/users/defunkt/gists{/gist_id} + starred_url: https://api.github.com/users/defunkt/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/defunkt/subscriptions + organizations_url: https://api.github.com/users/defunkt/orgs + repos_url: https://api.github.com/users/defunkt/repos + events_url: https://api.github.com/users/defunkt/events{/privacy} + received_events_url: https://api.github.com/users/defunkt/received_events + type: User + site_admin: true + created_at: '2023-02-15T08:30:00Z' + updated_at: '2023-02-15T14:45:00Z' + html_url: https://github.com/copilot/spaces/octo-org/3 + api_url: https://api.github.com/organizations/1/copilot-spaces/3 + - id: 85 + number: 4 + name: Development Resources + description: Shared development documentation and resources + owner: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + gravatar_id: '' + name: octo-org + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: octo-org + html_url: https://github.com/octo-org + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + creator: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-16T10:15:00Z' + updated_at: '2023-02-16T16:30:00Z' + html_url: https://github.com/copilot/spaces/octo-org/4 + api_url: https://api.github.com/organizations/1/copilot-spaces/4 + copilot-space-organization: + summary: Example response for an organization copilot space + value: + id: 84 + number: 3 + name: Team Planning Space + description: Organization space for team planning and coordination + general_instructions: Help the team with agile planning, sprint coordination, + and project management best practices + owner: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + gravatar_id: '' + name: octo-org + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: octo-org + html_url: https://github.com/octo-org + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + creator: + login: defunkt + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://github.com/images/error/defunkt_happy.gif + gravatar_id: '' + url: https://api.github.com/users/defunkt + html_url: https://github.com/defunkt + followers_url: https://api.github.com/users/defunkt/followers + following_url: https://api.github.com/users/defunkt/following{/other_user} + gists_url: https://api.github.com/users/defunkt/gists{/gist_id} + starred_url: https://api.github.com/users/defunkt/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/defunkt/subscriptions + organizations_url: https://api.github.com/users/defunkt/orgs + repos_url: https://api.github.com/users/defunkt/repos + events_url: https://api.github.com/users/defunkt/events{/privacy} + received_events_url: https://api.github.com/users/defunkt/received_events + type: User + site_admin: true + created_at: '2023-02-15T08:30:00Z' + updated_at: '2023-02-15T14:45:00Z' + html_url: https://github.com/copilot/spaces/octo-org/3 + api_url: https://api.github.com/organizations/1/copilot-spaces/3 + base_role: no_access + resources_attributes: + - id: 123 + resource_type: github_file + metadata: + repository_id: 456 + file_path: docs/planning.md + - id: 124 + resource_type: free_text + metadata: + name: Team Guidelines + text: Our team follows agile methodology copilot-organization-details: value: seat_breakdown: @@ -242626,6 +245441,165 @@ components: space: 976562499 collaborators: 0 private_repos: 9999 + copilot-spaces-user-list: + summary: Example response for listing user copilot spaces + value: + spaces: + - id: 42 + number: 1 + name: Personal Research Space + description: My personal space for research and development + owner: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-16T10:15:00Z' + updated_at: '2023-02-16T16:30:00Z' + html_url: https://github.com/copilot/spaces/octocat/1 + api_url: https://api.github.com/user/1/copilot-spaces/1 + - id: 43 + number: 2 + name: Learning Space + description: Space for learning new technologies + owner: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-17T08:20:00Z' + updated_at: '2023-02-17T14:45:00Z' + html_url: https://github.com/copilot/spaces/octocat/2 + api_url: https://api.github.com/user/1/copilot-spaces/2 + copilot-space-user: + summary: Example response for a user copilot space + value: + id: 42 + number: 5 + name: My Development Space + description: Personal space for React development patterns + general_instructions: Focus on React functional components, hooks, and modern + development patterns + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-15T08:30:00Z' + updated_at: '2023-02-15T14:45:00Z' + html_url: https://github.com/copilot/spaces/octocat/5 + api_url: https://api.github.com/user/1/copilot-spaces/5 + base_role: no_access + resources_attributes: + - id: 789 + resource_type: github_file + metadata: + repository_id: 1234 + file_path: src/components/App.tsx + - id: 790 + resource_type: free_text + metadata: + name: React Best Practices + text: Use functional components with hooks user-events-items: value: - id: '22249084947' diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 86ae92e21e..5c94afb103 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -136,6 +136,10 @@ "name": "users", "description": "Interact with and view information about users and also current user." }, + { + "name": "code-quality", + "description": "Insights into reliability, maintainability, and efficiency of your codebase." + }, { "name": "codespaces", "description": "Endpoints to manage Codespaces using the REST API." @@ -144,6 +148,10 @@ "name": "copilot", "description": "Endpoints to manage Copilot using the REST API." }, + { + "name": "copilot-spaces", + "description": "Endpoints to manage Copilot Spaces using the REST API." + }, { "name": "security-advisories", "description": "Manage security advisories." @@ -3795,7 +3803,7 @@ "/enterprises/{enterprise}/copilot/policies/coding_agent": { "put": { "summary": "Set the coding agent policy for an enterprise", - "description": "Sets the policy for Copilot coding agent usage across an enterprise.\n\nEnterprise owners can configure whether Copilot coding agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.\n\nOnly enterprise owners can set the coding agent policy for their enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "description": "Sets the policy for Copilot cloud agent usage across an enterprise.\n\nEnterprise owners can configure whether Copilot cloud agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.\n\nOnly enterprise owners can set the coding agent policy for their enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -3819,7 +3827,7 @@ "properties": { "policy_state": { "type": "string", - "description": "The policy state for Copilot coding agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.", + "description": "The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.", "enum": [ "enabled_for_all_orgs", "disabled_for_all_orgs", @@ -3861,7 +3869,7 @@ "/enterprises/{enterprise}/copilot/policies/coding_agent/organizations": { "post": { "summary": "Add organizations to the enterprise coding agent policy", - "description": "Enables Copilot coding agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can add organizations to the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "description": "Enables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can add organizations to the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -3876,7 +3884,7 @@ } ], "requestBody": { - "description": "The organizations to enable Copilot coding agent for", + "description": "The organizations to enable Copilot cloud agent for", "required": true, "content": { "application/json": { @@ -3885,7 +3893,7 @@ "properties": { "organizations": { "type": "array", - "description": "List of organization logins within the enterprise to enable Copilot coding agent for.", + "description": "List of organization logins within the enterprise to enable Copilot cloud agent for.", "items": { "type": "string" } @@ -3955,7 +3963,7 @@ }, "delete": { "summary": "Remove organizations from the enterprise coding agent policy", - "description": "Disables Copilot coding agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can remove organizations from the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "description": "Disables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can remove organizations from the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -3970,7 +3978,7 @@ } ], "requestBody": { - "description": "The organizations to disable Copilot coding agent for", + "description": "The organizations to disable Copilot cloud agent for", "required": true, "content": { "application/json": { @@ -3979,7 +3987,7 @@ "properties": { "organizations": { "type": "array", - "description": "List of organization logins within the enterprise to disable Copilot coding agent for.", + "description": "List of organization logins within the enterprise to disable Copilot cloud agent for.", "items": { "type": "string" } @@ -10895,6 +10903,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } } }, @@ -18893,6 +18905,1561 @@ } } }, + "/orgs/{org}/copilot-spaces": { + "get": { + "summary": "List organization Copilot Spaces", + "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-organization-copilot-spaces" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "spaces" + ], + "properties": { + "spaces": { + "type": "array", + "description": "The list of Copilot Spaces on this page of results.", + "items": { + "$ref": "#/components/schemas/copilot-space" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-spaces-organization-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "post": { + "summary": "Create an organization Copilot Space", + "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/create-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "Team Planning Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Organization space for team planning and coordination" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help the team with planning and coordination tasks" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions for organization members.\n- `no_access`: No default access (default)\n- `reader`: Organization members can read the space\n- `writer`: Organization members can read and edit the space\n- `admin`: Organization members have full admin access to the space", + "default": "no_access" + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/planning.md" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology and holds daily standups" + } + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-space-organization" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + } + }, + "/orgs/{org}/copilot-spaces/{space_number}": { + "get": { + "summary": "Get an organization Copilot Space", + "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/get-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-space-organization" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "put": { + "summary": "Set an organization Copilot Space", + "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "Updated Team Planning Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Updated organization space for team planning and coordination" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Updated instructions to help the team with planning and coordination tasks" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions for organization members. Changing this field requires admin permissions.\n- `no_access`: No default access (default)\n- `reader`: Organization members can read the space\n- `writer`: Organization members can read and edit the space\n- `admin`: Organization members have full admin access to the space" + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "Updated Team Planning Space", + "description": "Updated organization space for team planning and coordination", + "general_instructions": "Updated instructions to help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/updated-planning.md" + } + }, + { + "id": 789, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Team Guidelines", + "text": "Our updated team follows agile methodology and holds daily standups" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-space-organization" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "delete": { + "summary": "Delete an organization Copilot Space", + "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/delete-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "The Copilot Space has been successfully deleted." + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + } + }, + "/orgs/{org}/copilot-spaces/{space_number}/collaborators": { + "get": { + "summary": "List collaborators for an organization Copilot Space", + "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-collaborators-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "collaborators" + ], + "properties": { + "collaborators": { + "type": "array", + "description": "The list of collaborators for this Copilot Space.", + "items": { + "$ref": "#/components/schemas/copilot-space-collaborator" + } + } + } + }, + "examples": { + "default": { + "value": { + "collaborators": [ + { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + } + ] + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + }, + "post": { + "summary": "Add a collaborator to an organization Copilot Space", + "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/add-collaborator-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "actor_type", + "actor_identifier", + "role" + ], + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User", + "Team" + ], + "description": "The type of actor (user or team)." + }, + "actor_identifier": { + "type": "string", + "description": "The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role to grant to the collaborator." + } + } + }, + "examples": { + "user": { + "value": { + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" + } + }, + "team": { + "value": { + "actor_type": "Team", + "actor_identifier": "developers", + "role": "reader" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-collaborator" + }, + "examples": { + "user": { + "value": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "team": { + "value": { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + } + }, + "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { + "put": { + "summary": "Set a collaborator role for an organization Copilot Space", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-collaborator-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "The type of actor (user or team).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "role" + ], + "properties": { + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The new role to grant to the collaborator. Use `no_access` to remove the collaborator." + } + } + }, + "examples": { + "default": { + "value": { + "role": "admin" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-collaborator" + }, + "examples": { + "user": { + "value": { + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "team": { + "value": { + "actor_type": "Team", + "role": "admin", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 + } + } + } + } + } + }, + "204": { + "description": "Response when `role` is `no_access` and the collaborator was removed." + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + }, + "delete": { + "summary": "Remove a collaborator from an organization Copilot Space", + "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/remove-collaborator-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "The type of actor (user or team).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + } + }, + "/orgs/{org}/copilot-spaces/{space_number}/resources": { + "get": { + "summary": "List resources for an organization Copilot Space", + "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-resources-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "$ref": "#/components/schemas/copilot-space-resource" + } + } + } + }, + "examples": { + "default": { + "value": { + "resources": [ + { + "id": 1, + "resource_type": "repository", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42 + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + { + "id": 2, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + ] + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "resources" + } + }, + "post": { + "summary": "Create a resource for an organization Copilot Space", + "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/create-resource-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "resource_type", + "metadata" + ], + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ], + "description": "The type of resource to create." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata.", + "additionalProperties": true + } + } + }, + "examples": { + "free_text": { + "value": { + "resource_type": "free_text", + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + } + } + }, + "repository": { + "value": { + "resource_type": "repository", + "metadata": { + "repository_id": 42 + } + } + }, + "github_file": { + "value": { + "resource_type": "github_file", + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Resource created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "200": { + "description": "Duplicate github_file resource already exists", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "github_file", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "resources" + } + } + }, + "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": { + "get": { + "summary": "Get a resource for an organization Copilot Space", + "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/get-resource-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "resources" + } + }, + "put": { + "summary": "Set a resource for an organization Copilot Space", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-resource-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "Updated resource-specific metadata.", + "additionalProperties": true + } + } + }, + "examples": { + "default": { + "value": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "resources" + } + }, + "delete": { + "summary": "Delete a resource from an organization Copilot Space", + "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/delete-resource-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-an-organization-copilot-space" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "resources" + } + } + }, "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", @@ -19439,15 +21006,15 @@ }, "/orgs/{org}/copilot/coding-agent/permissions": { "get": { - "summary": "Get Copilot coding agent permissions for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about which repositories in an organization have been enabled\nor disabled for the Copilot coding agent.\n\nOrganization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Get Copilot cloud agent permissions for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about which repositories in an organization have been enabled\nor disabled for the Copilot cloud agent.\n\nOrganization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/get-copilot-coding-agent-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-cloud-agent-permissions-for-an-organization" }, "parameters": [ { @@ -19464,7 +21031,7 @@ "properties": { "enabled_repositories": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", "selected", @@ -19525,15 +21092,15 @@ } }, "put": { - "summary": "Set Copilot coding agent permissions for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets the policy for which repositories in an organization can use Copilot coding agent.\n\nOrganization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Set Copilot cloud agent permissions for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets the policy for which repositories in an organization can use Copilot cloud agent.\n\nOrganization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/set-copilot-coding-agent-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-cloud-agent-permissions-for-an-organization" }, "parameters": [ { @@ -19549,7 +21116,7 @@ "properties": { "enabled_repositories": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", "selected", @@ -19601,15 +21168,15 @@ }, "/orgs/{org}/copilot/coding-agent/permissions/repositories": { "get": { - "summary": "List repositories enabled for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists the selected repositories that are enabled for Copilot coding agent in an organization.\n\nOrganization owners can use this endpoint when the coding agent repository policy\nis set to `selected` to see which repositories have been enabled.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "List repositories enabled for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists the selected repositories that are enabled for Copilot cloud agent in an organization.\n\nOrganization owners can use this endpoint when the coding agent repository policy\nis set to `selected` to see which repositories have been enabled.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/list-copilot-coding-agent-selected-repositories-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -19677,15 +21244,15 @@ } }, "put": { - "summary": "Set selected repositories for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReplaces the list of selected repositories that are enabled for Copilot coding\nagent in an organization. This method can only be called when the coding agent\nrepository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Set selected repositories for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReplaces the list of selected repositories that are enabled for Copilot cloud\nagent in an organization. This method can only be called when the cloud agent\nrepository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/set-copilot-coding-agent-selected-repositories-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -19700,7 +21267,7 @@ "type": "object", "properties": { "selected_repository_ids": { - "description": "List of repository IDs to enable for Copilot coding agent.", + "description": "List of repository IDs to enable for Copilot cloud agent.", "type": "array", "items": { "type": "integer", @@ -19758,15 +21325,15 @@ }, "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}": { "put": { - "summary": "Enable a repository for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nAdds a repository to the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Enable a repository for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nAdds a repository to the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/enable-copilot-coding-agent-for-repository-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -19807,15 +21374,15 @@ } }, "delete": { - "summary": "Disable a repository for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemoves a repository from the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint.", + "summary": "Disable a repository for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemoves a repository from the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/disable-copilot-coding-agent-for-repository-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -34146,6 +35713,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for this repository. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim.", + "type": "boolean" } } }, @@ -37761,6 +39332,11 @@ { "op": "remove", "path": "/requestBody/content/application~1json/schema/properties/return_run_details" + }, + { + "op": "replace", + "path": "/responses/200/description", + "value": "Response including the workflow run ID and URLs." } ], "version": "2026-03-10" @@ -65326,6 +66902,18 @@ }, "assignee": { "$ref": "#/components/schemas/secret-scanning-alert-assignee" + }, + "validity": { + "type": [ + "string", + "null" + ], + "enum": [ + "active", + "inactive", + null + ], + "description": "Sets the validity of the secret scanning alert. Can be `active`, `inactive`, or `null` to clear the override." } }, "anyOf": [ @@ -65392,7 +66980,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" + "description": "State does not match the resolution or resolution comment, assignee does not have write access to the repository, or the requested validity change could not be applied to this alert" }, "503": { "$ref": "#/components/responses/service_unavailable" @@ -76659,6 +78247,1505 @@ ] } }, + "/users/{username}/copilot-spaces": { + "get": { + "summary": "List Copilot Spaces for a user", + "description": "Lists Copilot Spaces owned by a user. The authenticated user must have read access to the user's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes the user's own spaces, and public user spaces when accessing another user's spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-copilot-spaces-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "spaces" + ], + "properties": { + "spaces": { + "type": "array", + "description": "The list of Copilot Spaces on this page of results.", + "items": { + "$ref": "#/components/schemas/copilot-space" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-spaces-user-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "post": { + "summary": "Create a Copilot Space for a user", + "description": "Creates a new Copilot Space owned by a user. Only the authenticated user can create spaces for their own account.\n\nUsers can create personal Copilot Spaces for their individual use.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/create-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Personal space for development assistance" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help me with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "no_access" + ], + "description": "The base role that determines default permissions for the space.\n- `no_access`: No default access (default)\n- `reader`: Makes the space publicly readable\nNote: User spaces do not support writer or admin base roles.", + "default": "no_access" + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "My Development Space", + "description": "Personal space for development assistance", + "general_instructions": "Help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/App.js" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Development Notes", + "text": "Focus on clean code principles and modern React patterns" + } + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-space-user" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}": { + "get": { + "summary": "Get a Copilot Space for a user", + "description": "Gets details about a specific Copilot Space owned by a user. The authenticated user must have read access to the Space.\n\nPrivate user spaces require the authenticated user to be the owner of the space.\nPublic user spaces are accessible to any authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/get-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-space-user" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "put": { + "summary": "Set a Copilot Space for a user", + "description": "Updates a Copilot Space owned by a user. Only the authenticated user can update spaces for their own account.\n\nUsers can update their personal Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "Updated Development Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Updated personal space for development assistance" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Updated instructions to help me with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "no_access" + ], + "description": "The base role that determines default permissions for the space. Changing this field requires admin permissions.\n- `no_access`: No default access (default)\n- `reader`: Makes the space publicly readable\nNote: User spaces do not support writer or admin base roles." + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "Updated Development Space", + "description": "Updated personal space for development assistance", + "general_instructions": "Updated instructions to help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/UpdatedApp.js" + } + }, + { + "id": 123, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Development Notes", + "text": "Updated focus on clean code principles and modern React patterns" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-space-user" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "delete": { + "summary": "Delete a Copilot Space for a user", + "description": "Deletes a Copilot Space owned by a user. The authenticated user must be the owner of the space.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a space will remove all associated resources and configurations.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/delete-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "The Copilot Space has been successfully deleted." + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}/collaborators": { + "get": { + "summary": "List collaborators for a Copilot Space for a user", + "description": "Lists all collaborators for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nEach collaborator entry specifies which user has access to the space and at what level (reader, writer, or admin). The space owner is excluded from this list.\n\nTeam collaborators are not supported for user-owned Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-collaborators-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "collaborators" + ], + "properties": { + "collaborators": { + "type": "array", + "description": "The list of collaborators for this Copilot Space.", + "items": { + "$ref": "#/components/schemas/copilot-space-collaborator" + } + } + } + }, + "examples": { + "default": { + "value": { + "collaborators": [ + { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "User", + "role": "reader", + "login": "github-user", + "id": 67890, + "node_id": "MDQ6VXNlcjY3ODkw", + "avatar_url": "https://github.com/images/error/other_user.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github-user", + "html_url": "https://github.com/github-user", + "followers_url": "https://api.github.com/users/github-user/followers", + "following_url": "https://api.github.com/users/github-user/following{/other_user}", + "gists_url": "https://api.github.com/users/github-user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github-user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github-user/subscriptions", + "organizations_url": "https://api.github.com/users/github-user/orgs", + "repos_url": "https://api.github.com/users/github-user/repos", + "events_url": "https://api.github.com/users/github-user/events{/privacy}", + "received_events_url": "https://api.github.com/users/github-user/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "GitHub User", + "company": null, + "blog": "", + "location": null, + "email": null, + "hireable": null, + "bio": null, + "twitter_username": null, + "public_repos": 5, + "public_gists": 0, + "followers": 10, + "following": 5, + "created_at": "2010-01-14T04:33:35Z", + "updated_at": "2010-01-14T04:33:35Z" + } + ] + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + }, + "post": { + "summary": "Add a collaborator to a Copilot Space for a user", + "description": "Adds a collaborator to a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nTeam collaborators are not supported for user-owned Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/add-collaborator-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "actor_type", + "actor_identifier", + "role" + ], + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User", + "Team" + ], + "description": "The type of actor (must be `User` for user-owned spaces; `Team` will be rejected)." + }, + "actor_identifier": { + "type": "string", + "description": "The username of the collaborator. The numeric user ID is also accepted." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role to grant to the collaborator." + } + } + }, + "examples": { + "default": { + "value": { + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-collaborator" + }, + "examples": { + "default": { + "value": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { + "put": { + "summary": "Set a collaborator role for a Copilot Space for a user", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-collaborator-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "The type of actor (must be `User` for user-owned spaces; `Team` will be rejected).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username of the collaborator. The numeric user ID is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "role" + ], + "properties": { + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The new role to grant to the collaborator. Use `no_access` to remove the collaborator." + } + } + }, + "examples": { + "default": { + "value": { + "role": "admin" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-collaborator" + }, + "examples": { + "default": { + "value": { + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + } + } + } + } + }, + "204": { + "description": "Response when `role` is `no_access` and the collaborator was removed." + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + }, + "delete": { + "summary": "Remove a collaborator from a Copilot Space for a user", + "description": "Removes a collaborator from a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/remove-collaborator-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "The type of actor (must be `User` for user-owned spaces; `Team` will be rejected).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username of the collaborator. The numeric user ID is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}/resources": { + "get": { + "summary": "List resources for a Copilot Space for a user", + "description": "Lists all resources attached to a specific Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-resources-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "$ref": "#/components/schemas/copilot-space-resource" + } + } + } + }, + "examples": { + "default": { + "value": { + "resources": [ + { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + ] + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" + } + }, + "post": { + "summary": "Create a resource for a Copilot Space for a user", + "description": "Creates a new resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/create-resource-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "resource_type", + "metadata" + ], + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ], + "description": "The type of resource to create." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata.", + "additionalProperties": true + } + } + }, + "examples": { + "free_text": { + "value": { + "resource_type": "free_text", + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + } + } + }, + "repository": { + "value": { + "resource_type": "repository", + "metadata": { + "repository_id": 42 + } + } + }, + "github_file": { + "value": { + "resource_type": "github_file", + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Resource created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "200": { + "description": "Duplicate github_file resource already exists", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "github_file", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}": { + "get": { + "summary": "Get a resource for a Copilot Space for a user", + "description": "Gets a specific resource attached to a Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/get-resource-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" + } + }, + "put": { + "summary": "Set a resource for a Copilot Space for a user", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-resource-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "Updated resource-specific metadata.", + "additionalProperties": true + } + } + }, + "examples": { + "default": { + "value": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-space-resource" + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" + } + }, + "delete": { + "summary": "Delete a resource from a Copilot Space for a user", + "description": "Deletes a resource from a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/delete-resource-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" + } + } + }, "/users/{username}/docker/conflicts": { "get": { "summary": "Get list of conflicting packages during Docker migration for user", @@ -106387,7 +109474,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -116320,6 +119407,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } }, "required": [ @@ -118257,6 +121348,394 @@ "key" ] }, + "copilot-space": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { + "anyOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/organization-simple" + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "$ref": "#/components/schemas/simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + }, + "copilot-space-collaborator": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + }, + "copilot-space-resource": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, "copilot-organization-seat-breakdown": { "title": "Copilot Seat Breakdown", "description": "The breakdown of Copilot Business seats for the organization.", @@ -128718,6 +132197,14 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether the repository has opted in to the immutable OIDC subject claim format. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim. If not set at the repository level, falls back to the organization-level setting.", + "type": "boolean" + }, + "sub_claim_prefix": { + "description": "The current `sub` claim prefix for this repository.", + "type": "string" } }, "required": [ @@ -304463,12 +307950,298 @@ "cpus": 4 }, "prebuild": false, - "devcontainer_path": ".devcontainer/devcontainer.json", + "devcontainer_path": ".devcontainer/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", + "recent_folders": [] + }, + { + "id": 1, + "name": "monalisa-octocat-hello-world-3f89ada1j3", + "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "billable_owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer/foobar/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop", + "recent_folders": [] + }, + { + "id": 1, + "name": "monalisa-octocat-hello-world-f8adfad99a", + "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "billable_owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", "git_status": { "ahead": 0, "behind": 0, @@ -304478,183 +308251,141 @@ }, "location": "WestUs2", "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", - "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", - "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", + "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", "recent_folders": [] + } + ] + } + }, + "repo-codespaces-secret-paginated": { + "value": { + "total_count": 2, + "secrets": [ + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" }, { - "id": 1, - "name": "monalisa-octocat-hello-world-3f89ada1j3", - "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", + "name": "GIST_ID", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z", + "visibility": "all" + } + ] + } + }, + "codespaces-public-key": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + }, + "repo-codespaces-secret": { + "value": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" + } + }, + "copilot-spaces-organization-list": { + "summary": "Example response for listing organization copilot spaces", + "value": { + "spaces": [ + { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", "owner": { - "login": "octocat", + "login": "octo-org", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" }, - "billable_owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", "type": "User", - "site_admin": false - }, - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 - }, - "prebuild": false, - "devcontainer_path": ".devcontainer/foobar/devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" + "site_admin": true }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", - "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start", - "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop", - "recent_folders": [] + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3" }, { - "id": 1, - "name": "monalisa-octocat-hello-world-f8adfad99a", - "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", + "id": 85, + "number": 4, + "name": "Development Resources", + "description": "Shared development documentation and resources", "owner": { - "login": "octocat", + "login": "octo-org", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" }, - "billable_owner": { + "creator": { "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", + "id": 3, + "node_id": "MDQ6VXNlcjM=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", @@ -304671,141 +308402,92 @@ "type": "User", "site_admin": false }, - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 - }, - "prebuild": false, - "devcontainer_path": ".devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" - }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", - "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", - "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", - "recent_folders": [] + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/4", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/4" } ] } }, - "repo-codespaces-secret-paginated": { + "copilot-space-organization": { + "summary": "Example response for an organization copilot space", "value": { - "total_count": 2, - "secrets": [ + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } }, { - "name": "GIST_ID", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z", - "visibility": "all" + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } } ] } }, - "codespaces-public-key": { - "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - } - }, - "repo-codespaces-secret": { - "value": { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" - } - }, "copilot-organization-details": { "value": { "seat_breakdown": { @@ -328142,6 +331824,186 @@ } } }, + "copilot-spaces-user-list": { + "summary": "Example response for listing user copilot spaces", + "value": { + "spaces": [ + { + "id": 42, + "number": 1, + "name": "Personal Research Space", + "description": "My personal space for research and development", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/1", + "api_url": "https://api.github.com/user/1/copilot-spaces/1" + }, + { + "id": 43, + "number": 2, + "name": "Learning Space", + "description": "Space for learning new technologies", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-17T08:20:00Z", + "updated_at": "2023-02-17T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/2", + "api_url": "https://api.github.com/user/1/copilot-spaces/2" + } + ] + } + }, + "copilot-space-user": { + "summary": "Example response for a user copilot space", + "value": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + } + }, "user-events-items": { "value": [ { diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index edc810080e..bee45867e9 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -73,10 +73,15 @@ tags: description: Interact with GitHub Teams. - name: users description: Interact with and view information about users and also current user. +- name: code-quality + description: Insights into reliability, maintainability, and efficiency of your + codebase. - name: codespaces description: Endpoints to manage Codespaces using the REST API. - name: copilot description: Endpoints to manage Copilot using the REST API. +- name: copilot-spaces + description: Endpoints to manage Copilot Spaces using the REST API. - name: security-advisories description: Manage security advisories. - name: interactions @@ -2739,9 +2744,9 @@ paths: put: summary: Set the coding agent policy for an enterprise description: |- - Sets the policy for Copilot coding agent usage across an enterprise. + Sets the policy for Copilot cloud agent usage across an enterprise. - Enterprise owners can configure whether Copilot coding agent is enabled for all + Enterprise owners can configure whether Copilot cloud agent is enabled for all organizations, disabled for all organizations, configured by individual organization admins, or enabled for selected organizations only. @@ -2766,7 +2771,7 @@ paths: properties: policy_state: type: string - description: The policy state for Copilot coding agent in the enterprise. + description: The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`. enum: @@ -2794,7 +2799,7 @@ paths: post: summary: Add organizations to the enterprise coding agent policy description: |- - Enables Copilot coding agent for the specified organizations within the enterprise. + Enables Copilot cloud agent for the specified organizations within the enterprise. The enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before using this endpoint. Organizations can be specified by login or matched via custom properties. @@ -2813,7 +2818,7 @@ paths: parameters: - "$ref": "#/components/parameters/enterprise" requestBody: - description: The organizations to enable Copilot coding agent for + description: The organizations to enable Copilot cloud agent for required: true content: application/json: @@ -2823,7 +2828,7 @@ paths: organizations: type: array description: List of organization logins within the enterprise to - enable Copilot coding agent for. + enable Copilot cloud agent for. items: type: string custom_properties: @@ -2871,7 +2876,7 @@ paths: delete: summary: Remove organizations from the enterprise coding agent policy description: |- - Disables Copilot coding agent for the specified organizations within the enterprise. + Disables Copilot cloud agent for the specified organizations within the enterprise. The enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before using this endpoint. Organizations can be specified by login or matched via custom properties. @@ -2890,7 +2895,7 @@ paths: parameters: - "$ref": "#/components/parameters/enterprise" requestBody: - description: The organizations to disable Copilot coding agent for + description: The organizations to disable Copilot cloud agent for required: true content: application/json: @@ -2900,7 +2905,7 @@ paths: organizations: type: array description: List of organization logins within the enterprise to - disable Copilot coding agent for. + disable Copilot cloud agent for. items: type: string custom_properties: @@ -7802,6 +7807,12 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the name-based + format. + type: boolean examples: default: "$ref": "#/components/examples/oidc-custom-sub" @@ -13712,6 +13723,1185 @@ paths: enabledForGitHubApps: false category: codespaces subcategory: organization-secrets + "/orgs/{org}/copilot-spaces": + get: + summary: List organization Copilot Spaces + description: |- + Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces. + + Only Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-organization-copilot-spaces + parameters: + - "$ref": "#/components/parameters/org" + - name: per_page + description: The number of results per page (max 100). + in: query + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: before + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + in: query + schema: + type: string + - name: after + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. + in: query + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - spaces + properties: + spaces: + type: array + description: The list of Copilot Spaces on this page of results. + items: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-spaces-organization-list" + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + post: + summary: Create an organization Copilot Space + description: |- + Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization. + + Organization members with appropriate permissions can create Copilot Spaces to be shared within their organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - Team Planning Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Organization space for team planning and coordination + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Help the team with planning and coordination tasks + base_role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: |- + The base role that determines default permissions for organization members. + - `no_access`: No default access (default) + - `reader`: Organization members can read the space + - `writer`: Organization members can read and edit the space + - `admin`: Organization members have full admin access to the space + default: no_access + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + required: + - name + examples: + default: + value: + name: Team Planning Space + description: Organization space for team planning and coordination + general_instructions: Help the team with planning and coordination + tasks + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 123456 + file_path: docs/planning.md + - resource_type: free_text + metadata: + name: Team Guidelines + text: Our team follows agile methodology and holds daily standups + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-space-organization" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + "/orgs/{org}/copilot-spaces/{space_number}": + get: + summary: Get an organization Copilot Space + description: |- + Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space. + + Internal Spaces require the authenticated user to be a member of the organization or have been granted read permissions. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-space-organization" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + put: + summary: Set an organization Copilot Space + description: |- + Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization. + + Organization members with appropriate permissions can update Copilot Spaces owned by their organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - Updated Team Planning Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Updated organization space for team planning and coordination + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Updated instructions to help the team with planning and coordination + tasks + base_role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: |- + The base role that determines default permissions for organization members. Changing this field requires admin permissions. + - `no_access`: No default access (default) + - `reader`: Organization members can read the space + - `writer`: Organization members can read and edit the space + - `admin`: Organization members have full admin access to the space + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + examples: + default: + value: + name: Updated Team Planning Space + description: Updated organization space for team planning and coordination + general_instructions: Updated instructions to help the team with + planning and coordination tasks + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 123456 + file_path: docs/updated-planning.md + - id: 789 + _destroy: true + - id: 456 + resource_type: free_text + metadata: + name: Updated Team Guidelines + text: Our updated team follows agile methodology and holds daily + standups + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-space-organization" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + delete: + summary: Delete an organization Copilot Space + description: |- + Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization. + + **Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations. + + Organization members with appropriate permissions can delete Copilot Spaces owned by their organization. + + OAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '204': + description: The Copilot Space has been successfully deleted. + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + "/orgs/{org}/copilot-spaces/{space_number}/collaborators": + get: + summary: List collaborators for an organization Copilot Space + description: |- + Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators. + + Each collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list. + + **Note:** Team collaborators listed here are teams that are defined in the organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-collaborators-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - collaborators + properties: + collaborators: + type: array + description: The list of collaborators for this Copilot Space. + items: + "$ref": "#/components/schemas/copilot-space-collaborator" + examples: + default: + value: + collaborators: + - actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + - actor_type: Team + role: reader + id: 67890 + node_id: MDQ6VGVhbTY3ODkw + url: https://api.github.com/teams/67890 + html_url: https://github.com/orgs/octo-org/teams/developers + name: Developers + slug: developers + description: Team of developers + privacy: closed + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/67890/members{/member} + repositories_url: https://api.github.com/teams/67890/repos + parent: + created_at: '2017-07-14T16:53:42Z' + updated_at: '2017-08-17T12:37:15Z' + organization: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + post: + summary: Add a collaborator to an organization Copilot Space + description: |- + Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. + + **Note:** When adding users as collaborators, they must already be members of the organization. + When adding teams as collaborators, they must be defined in the organization. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/add-collaborator-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - actor_type + - actor_identifier + - role + properties: + actor_type: + type: string + enum: + - User + - Team + description: The type of actor (user or team). + actor_identifier: + type: string + description: The username (for users) or team slug (for teams). + The numeric ID of a user or team is also accepted. + role: + type: string + enum: + - reader + - writer + - admin + description: The role to grant to the collaborator. + examples: + user: + value: + actor_type: User + actor_identifier: octocat + role: writer + team: + value: + actor_type: Team + actor_identifier: developers + role: reader + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-collaborator" + examples: + user: + value: + actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + team: + value: + actor_type: Team + role: reader + id: 67890 + node_id: MDQ6VGVhbTY3ODkw + url: https://api.github.com/teams/67890 + html_url: https://github.com/orgs/octo-org/teams/developers + name: Developers + slug: developers + type: Team + description: Team of developers + privacy: closed + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/67890/members{/member} + repositories_url: https://api.github.com/teams/67890/repos + parent: + organization_id: 1 + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": + put: + summary: Set a collaborator role for an organization Copilot Space + description: |- + Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-collaborator-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (user or team). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username (for users) or team slug (for teams). The numeric + ID of a user or team is also accepted. + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - role + properties: + role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: The new role to grant to the collaborator. Use `no_access` + to remove the collaborator. + examples: + default: + value: + role: admin + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-collaborator" + examples: + user: + value: + actor_type: User + role: admin + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + team: + value: + actor_type: Team + role: admin + id: 67890 + node_id: MDQ6VGVhbTY3ODkw + url: https://api.github.com/teams/67890 + html_url: https://github.com/orgs/octo-org/teams/developers + name: Developers + slug: developers + type: Team + description: Team of developers + privacy: closed + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/67890/members{/member} + repositories_url: https://api.github.com/teams/67890/repos + parent: + organization_id: 1 + '204': + description: Response when `role` is `no_access` and the collaborator was + removed. + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + delete: + summary: Remove a collaborator from an organization Copilot Space + description: |- + Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/remove-collaborator-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (user or team). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username (for users) or team slug (for teams). The numeric + ID of a user or team is also accepted. + in: path + required: true + schema: + type: string + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + "/orgs/{org}/copilot-spaces/{space_number}/resources": + get: + summary: List resources for an organization Copilot Space + description: |- + Lists all resources attached to a specific Copilot Space owned by an organization. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-resources-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - resources + properties: + resources: + type: array + description: The list of resources attached to this Copilot Space. + items: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + resources: + - id: 1 + resource_type: repository + copilot_chat_attachment_id: + metadata: + repository_id: 42 + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + - id: 2 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + post: + summary: Create a resource for an organization Copilot Space + description: |- + Creates a new resource in a specific Copilot Space owned by an organization. + The authenticated user must have write permissions on the space. + + The following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`. + The `uploaded_text_file` and `media_content` types are not supported via this endpoint. + + For `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - resource_type + - metadata + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + description: The type of resource to create. + metadata: + type: object + description: Resource-specific metadata. + additionalProperties: true + examples: + free_text: + value: + resource_type: free_text + metadata: + name: notes.txt + text: Some helpful notes + repository: + value: + resource_type: repository + metadata: + repository_id: 42 + github_file: + value: + resource_type: github_file + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + responses: + '201': + description: Resource created + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '200': + description: Duplicate github_file resource already exists + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: github_file + copilot_chat_attachment_id: + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": + get: + summary: Get a resource for an organization Copilot Space + description: |- + Gets a specific resource attached to a Copilot Space owned by an organization. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + put: + summary: Set a resource for an organization Copilot Space + description: |- + Updates the metadata of a resource in a specific Copilot Space owned by an organization. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + description: Updated resource-specific metadata. + additionalProperties: true + examples: + default: + value: + metadata: + name: updated-notes.txt + text: Updated content + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: updated-notes.txt + text: Updated content + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T12:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + delete: + summary: Delete a resource from an organization Copilot Space + description: |- + Deletes a resource from a specific Copilot Space owned by an organization. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-an-organization-copilot-space + parameters: + - "$ref": "#/components/parameters/org" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources "/orgs/{org}/copilot/billing": get: summary: Get Copilot seat information and settings for an organization @@ -14158,15 +15348,15 @@ paths: subcategory: copilot-user-management "/orgs/{org}/copilot/coding-agent/permissions": get: - summary: Get Copilot coding agent permissions for an organization + summary: Get Copilot cloud agent permissions for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Gets information about which repositories in an organization have been enabled - or disabled for the Copilot coding agent. + or disabled for the Copilot cloud agent. - Organization owners can configure whether Copilot coding agent is enabled for + Organization owners can configure whether Copilot cloud agent is enabled for all repositories, selected repositories, or no repositories owned by organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -14175,7 +15365,7 @@ paths: operationId: copilot/get-copilot-coding-agent-permissions-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-cloud-agent-permissions-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: @@ -14189,7 +15379,7 @@ paths: enabled_repositories: type: string description: The policy for which repositories can use Copilot - coding agent. Can be one of `all`, `selected`, or `none`. + cloud agent. Can be one of `all`, `selected`, or `none`. enum: - all - selected @@ -14228,14 +15418,14 @@ paths: category: copilot subcategory: copilot-coding-agent-management put: - summary: Set Copilot coding agent permissions for an organization + summary: Set Copilot cloud agent permissions for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. - Sets the policy for which repositories in an organization can use Copilot coding agent. + Sets the policy for which repositories in an organization can use Copilot cloud agent. - Organization owners can configure whether Copilot coding agent is enabled for + Organization owners can configure whether Copilot cloud agent is enabled for all repositories, selected repositories, or no repositories owned by the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -14244,7 +15434,7 @@ paths: operationId: copilot/set-copilot-coding-agent-permissions-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-cloud-agent-permissions-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -14256,7 +15446,7 @@ paths: properties: enabled_repositories: type: string - description: The policy for which repositories can use Copilot coding + description: The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`. enum: - all @@ -14288,12 +15478,12 @@ paths: subcategory: copilot-coding-agent-management "/orgs/{org}/copilot/coding-agent/permissions/repositories": get: - summary: List repositories enabled for Copilot coding agent in an organization + summary: List repositories enabled for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists the selected repositories that are enabled for Copilot coding agent in an organization. + Lists the selected repositories that are enabled for Copilot cloud agent in an organization. Organization owners can use this endpoint when the coding agent repository policy is set to `selected` to see which repositories have been enabled. @@ -14304,7 +15494,7 @@ paths: operationId: copilot/list-copilot-coding-agent-selected-repositories-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-cloud-agent-in-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" @@ -14345,13 +15535,13 @@ paths: category: copilot subcategory: copilot-coding-agent-management put: - summary: Set selected repositories for Copilot coding agent in an organization + summary: Set selected repositories for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. - Replaces the list of selected repositories that are enabled for Copilot coding - agent in an organization. This method can only be called when the coding agent + Replaces the list of selected repositories that are enabled for Copilot cloud + agent in an organization. This method can only be called when the cloud agent repository policy is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -14360,7 +15550,7 @@ paths: operationId: copilot/set-copilot-coding-agent-selected-repositories-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-cloud-agent-in-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -14371,7 +15561,7 @@ paths: type: object properties: selected_repository_ids: - description: List of repository IDs to enable for Copilot coding + description: List of repository IDs to enable for Copilot cloud agent. type: array items: @@ -14407,14 +15597,14 @@ paths: subcategory: copilot-coding-agent-management "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}": put: - summary: Enable a repository for Copilot coding agent in an organization + summary: Enable a repository for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Adds a repository to the list of selected repositories enabled for Copilot - coding agent in an organization. This method can only be called when the - coding agent repository policy is set to `selected`. + cloud agent in an organization. This method can only be called when the + cloud agent repository policy is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -14422,7 +15612,7 @@ paths: operationId: copilot/enable-copilot-coding-agent-for-repository-in-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-cloud-agent-in-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/repository-id" @@ -14447,14 +15637,14 @@ paths: category: copilot subcategory: copilot-coding-agent-management delete: - summary: Disable a repository for Copilot coding agent in an organization + summary: Disable a repository for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Removes a repository from the list of selected repositories enabled for Copilot - coding agent in an organization. This method can only be called when the - coding agent repository policy is set to `selected`. + cloud agent in an organization. This method can only be called when the + cloud agent repository policy is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint. tags: @@ -14462,7 +15652,7 @@ paths: operationId: copilot/disable-copilot-coding-agent-for-repository-in-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-cloud-agent-in-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/repository-id" @@ -24844,6 +26034,11 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for this repository. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. + type: boolean examples: default: value: @@ -27397,6 +28592,9 @@ paths: path: "/responses/204" - op: remove path: "/requestBody/content/application~1json/schema/properties/return_run_details" + - op: replace + path: "/responses/200/description" + value: Response including the workflow run ID and URLs. version: '2026-03-10' "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": put: @@ -47424,6 +48622,16 @@ paths: "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" assignee: "$ref": "#/components/schemas/secret-scanning-alert-assignee" + validity: + type: + - string + - 'null' + enum: + - active + - inactive + - + description: Sets the validity of the secret scanning alert. Can + be `active`, `inactive`, or `null` to clear the override. anyOf: - required: - state @@ -47462,7 +48670,8 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment, - or assignee does not have write access to the repository + assignee does not have write access to the repository, or the requested + validity change could not be applied to this alert '503': "$ref": "#/components/responses/service_unavailable" x-github: @@ -55598,6 +56807,1138 @@ paths: properties: bundle: version: '2026-03-10' + "/users/{username}/copilot-spaces": + get: + summary: List Copilot Spaces for a user + description: |- + Lists Copilot Spaces owned by a user. The authenticated user must have read access to the user's Copilot Spaces. + + Only Spaces that are readable by the authenticated user are returned. This includes the user's own spaces, and public user spaces when accessing another user's spaces. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-copilot-spaces-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: per_page + description: The number of results per page (max 100). + in: query + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: before + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + in: query + schema: + type: string + - name: after + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. + in: query + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - spaces + properties: + spaces: + type: array + description: The list of Copilot Spaces on this page of results. + items: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-spaces-user-list" + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + post: + summary: Create a Copilot Space for a user + description: |- + Creates a new Copilot Space owned by a user. Only the authenticated user can create spaces for their own account. + + Users can create personal Copilot Spaces for their individual use. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - My Development Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Personal space for development assistance + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Help me with React development patterns and best practices + base_role: + type: string + enum: + - reader + - no_access + description: |- + The base role that determines default permissions for the space. + - `no_access`: No default access (default) + - `reader`: Makes the space publicly readable + Note: User spaces do not support writer or admin base roles. + default: no_access + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + required: + - name + examples: + default: + value: + name: My Development Space + description: Personal space for development assistance + general_instructions: Help me with React development patterns and + best practices + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 789012 + file_path: src/components/App.js + - resource_type: free_text + metadata: + name: Development Notes + text: Focus on clean code principles and modern React patterns + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-space-user" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + "/users/{username}/copilot-spaces/{space_number}": + get: + summary: Get a Copilot Space for a user + description: |- + Gets details about a specific Copilot Space owned by a user. The authenticated user must have read access to the Space. + + Private user spaces require the authenticated user to be the owner of the space. + Public user spaces are accessible to any authenticated user. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-space-user" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + put: + summary: Set a Copilot Space for a user + description: |- + Updates a Copilot Space owned by a user. Only the authenticated user can update spaces for their own account. + + Users can update their personal Copilot Spaces. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - Updated Development Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Updated personal space for development assistance + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Updated instructions to help me with React development patterns + and best practices + base_role: + type: string + enum: + - reader + - no_access + description: |- + The base role that determines default permissions for the space. Changing this field requires admin permissions. + - `no_access`: No default access (default) + - `reader`: Makes the space publicly readable + Note: User spaces do not support writer or admin base roles. + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + examples: + default: + value: + name: Updated Development Space + description: Updated personal space for development assistance + general_instructions: Updated instructions to help me with React + development patterns and best practices + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 789012 + file_path: src/components/UpdatedApp.js + - id: 123 + _destroy: true + - id: 456 + resource_type: free_text + metadata: + name: Updated Development Notes + text: Updated focus on clean code principles and modern React + patterns + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space" + examples: + default: + "$ref": "#/components/examples/copilot-space-user" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + delete: + summary: Delete a Copilot Space for a user + description: |- + Deletes a Copilot Space owned by a user. The authenticated user must be the owner of the space. + + **Warning:** This action is permanent and cannot be undone. Deleting a space will remove all associated resources and configurations. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '204': + description: The Copilot Space has been successfully deleted. + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + "/users/{username}/copilot-spaces/{space_number}/collaborators": + get: + summary: List collaborators for a Copilot Space for a user + description: |- + Lists all collaborators for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + Each collaborator entry specifies which user has access to the space and at what level (reader, writer, or admin). The space owner is excluded from this list. + + Team collaborators are not supported for user-owned Copilot Spaces. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-collaborators-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - collaborators + properties: + collaborators: + type: array + description: The list of collaborators for this Copilot Space. + items: + "$ref": "#/components/schemas/copilot-space-collaborator" + examples: + default: + value: + collaborators: + - actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + - actor_type: User + role: reader + login: github-user + id: 67890 + node_id: MDQ6VXNlcjY3ODkw + avatar_url: https://github.com/images/error/other_user.gif + gravatar_id: '' + url: https://api.github.com/users/github-user + html_url: https://github.com/github-user + followers_url: https://api.github.com/users/github-user/followers + following_url: https://api.github.com/users/github-user/following{/other_user} + gists_url: https://api.github.com/users/github-user/gists{/gist_id} + starred_url: https://api.github.com/users/github-user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github-user/subscriptions + organizations_url: https://api.github.com/users/github-user/orgs + repos_url: https://api.github.com/users/github-user/repos + events_url: https://api.github.com/users/github-user/events{/privacy} + received_events_url: https://api.github.com/users/github-user/received_events + type: User + user_view_type: public + site_admin: false + name: GitHub User + company: + blog: '' + location: + email: + hireable: + bio: + twitter_username: + public_repos: 5 + public_gists: 0 + followers: 10 + following: 5 + created_at: '2010-01-14T04:33:35Z' + updated_at: '2010-01-14T04:33:35Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + post: + summary: Add a collaborator to a Copilot Space for a user + description: |- + Adds a collaborator to a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + Team collaborators are not supported for user-owned Copilot Spaces. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/add-collaborator-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - actor_type + - actor_identifier + - role + properties: + actor_type: + type: string + enum: + - User + - Team + description: The type of actor (must be `User` for user-owned spaces; + `Team` will be rejected). + actor_identifier: + type: string + description: The username of the collaborator. The numeric user + ID is also accepted. + role: + type: string + enum: + - reader + - writer + - admin + description: The role to grant to the collaborator. + examples: + default: + value: + actor_type: User + actor_identifier: octocat + role: writer + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-collaborator" + examples: + default: + value: + actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": + put: + summary: Set a collaborator role for a Copilot Space for a user + description: |- + Updates the role of a collaborator for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-collaborator-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (must be `User` for user-owned spaces; `Team` + will be rejected). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username of the collaborator. The numeric user ID is also + accepted. + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - role + properties: + role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: The new role to grant to the collaborator. Use `no_access` + to remove the collaborator. + examples: + default: + value: + role: admin + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-collaborator" + examples: + default: + value: + actor_type: User + role: admin + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + '204': + description: Response when `role` is `no_access` and the collaborator was + removed. + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + delete: + summary: Remove a collaborator from a Copilot Space for a user + description: |- + Removes a collaborator from a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/remove-collaborator-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (must be `User` for user-owned spaces; `Team` + will be rejected). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username of the collaborator. The numeric user ID is also + accepted. + in: path + required: true + schema: + type: string + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + "/users/{username}/copilot-spaces/{space_number}/resources": + get: + summary: List resources for a Copilot Space for a user + description: |- + Lists all resources attached to a specific Copilot Space owned by a user. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-resources-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - resources + properties: + resources: + type: array + description: The list of resources attached to this Copilot Space. + items: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + resources: + - id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + post: + summary: Create a resource for a Copilot Space for a user + description: |- + Creates a new resource in a specific Copilot Space owned by a user. + The authenticated user must have write permissions on the space. + + The following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`. + The `uploaded_text_file` and `media_content` types are not supported via this endpoint. + + For `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status. + + OAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - resource_type + - metadata + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + description: The type of resource to create. + metadata: + type: object + description: Resource-specific metadata. + additionalProperties: true + examples: + free_text: + value: + resource_type: free_text + metadata: + name: notes.txt + text: Some helpful notes + repository: + value: + resource_type: repository + metadata: + repository_id: 42 + github_file: + value: + resource_type: github_file + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + responses: + '201': + description: Resource created + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '200': + description: Duplicate github_file resource already exists + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: github_file + copilot_chat_attachment_id: + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}": + get: + summary: Get a resource for a Copilot Space for a user + description: |- + Gets a specific resource attached to a Copilot Space owned by a user. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + put: + summary: Set a resource for a Copilot Space for a user + description: |- + Updates the metadata of a resource in a specific Copilot Space owned by a user. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + description: Updated resource-specific metadata. + additionalProperties: true + examples: + default: + value: + metadata: + name: updated-notes.txt + text: Updated content + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-space-resource" + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: updated-notes.txt + text: Updated content + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T12:00:00Z' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + delete: + summary: Delete a resource from a Copilot Space for a user + description: |- + Deletes a resource from a specific Copilot Space owned by a user. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-a-copilot-space-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources "/users/{username}/docker/conflicts": get: summary: Get list of conflicting packages during Docker migration for user @@ -76746,7 +79087,7 @@ components: organization_copilot_agent_settings: type: string description: The level of permission to grant the access token to view and - manage Copilot coding agent settings for an organization. + manage Copilot cloud agent settings for an organization. enum: - read - write @@ -84154,6 +86495,11 @@ components: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim format + for the organization. When `true`, new OIDC tokens will use a stable, + repository-ID-based `sub` claim instead of the name-based format. + type: boolean required: - include_claim_keys empty-object: @@ -85639,6 +87985,296 @@ components: required: - key_id - key + copilot-space: + title: Space + description: A GitHub Copilot Space represents an interactive AI workspace where + users can ask questions and get assistance. + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the space. + examples: + - 42 + number: + type: integer + description: The number that identifies the space within its owner. + examples: + - 1 + name: + type: string + description: The display name of the space. + examples: + - My Development Space + description: + type: + - string + - 'null' + description: A description of the space. + examples: + - A space for discussing React development patterns + general_instructions: + type: + - string + - 'null' + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Help with React development patterns and best practices + base_role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: |- + The base role that determines default permissions. + - `no_access`: No default access + - `reader`: Default read permissions + - `writer`: Default write permissions (organization spaces only) + - `admin`: Default admin permissions (organization spaces only) + examples: + - no_access + owner: + anyOf: + - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/organization-simple" + description: The user or organization that owns this space. + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + description: The date and time the space was created. + examples: + - '2023-01-01T00:00:00Z' + updated_at: + type: string + format: date-time + description: The date and time the space was last updated. + examples: + - '2023-01-01T12:00:00Z' + html_url: + type: string + format: uri + description: The HTML URL of the space. + examples: + - https://github.com/copilot/spaces/octo-org/5 + api_url: + type: string + format: uri + description: The API URL of the space. + examples: + - https://api.github.com/organizations/1/copilot-spaces/5 + resources_attributes: + type: array + description: Resources attached to the space. + items: + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the resource. + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + copilot_chat_attachment_id: + type: + - integer + - 'null' + format: int64 + description: The unique identifier of the chat attachment for uploaded + files or media content. + created_at: + type: string + format: date-time + description: The date and time the resource was created. + updated_at: + type: string + format: date-time + description: The date and time the resource was last updated. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + copilot_chat_attachment_id: + type: integer + description: Chat attachment ID for uploaded files or media. + media_type: + type: string + description: Media type for media content resources. + url: + type: string + description: URL for media content resources. + height: + type: integer + description: Height for media content resources. + width: + type: integer + description: Width for media content resources. + required: + - id + - number + - name + - base_role + - owner + - creator + - created_at + - updated_at + - html_url + - api_url + additionalProperties: false + copilot-space-collaborator: + title: Copilot Space Collaborator + description: A collaborator (user or team) of a Copilot Space + type: object + anyOf: + - allOf: + - "$ref": "#/components/schemas/simple-user" + - type: object + properties: + actor_type: + type: string + enum: + - User + description: The collaborator actor type. + role: + type: string + enum: + - reader + - writer + - admin + description: The role granted to the collaborator + required: + - actor_type + - role + - type: object + properties: + actor_type: + type: string + enum: + - Team + description: The collaborator actor type. + role: + type: string + enum: + - reader + - writer + - admin + description: The role granted to the collaborator + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + type: + type: string + enum: + - Team + description: + type: + - string + - 'null' + privacy: + type: string + notification_setting: + type: string + url: + type: string + format: uri + html_url: + type: string + format: uri + members_url: + type: string + repositories_url: + type: string + format: uri + organization_id: + type: integer + parent: + type: + - 'null' + required: + - actor_type + - role + - id + - node_id + - name + - slug + - type + copilot-space-resource: + title: Copilot Space Resource + description: A resource attached to a Copilot Space. + type: object + properties: + id: + type: integer + description: The unique identifier of the resource. + resource_type: + type: string + description: The type of the resource. + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + copilot_chat_attachment_id: + type: + - integer + - 'null' + description: The ID of the associated chat attachment, if any. + metadata: + type: object + description: Resource-specific metadata. The keys and values depend on the + resource type. + additionalProperties: true + created_at: + type: string + format: date-time + description: The date and time the resource was created. + updated_at: + type: string + format: date-time + description: The date and time the resource was last updated. + required: + - id + - resource_type + - metadata + - created_at + - updated_at copilot-organization-seat-breakdown: title: Copilot Seat Breakdown description: The breakdown of Copilot Business seats for the organization. @@ -93454,6 +96090,15 @@ components: type: array items: type: string + use_immutable_subject: + description: Whether the repository has opted in to the immutable OIDC subject + claim format. When `true`, OIDC tokens will use a stable, repository-ID-based + `sub` claim. If not set at the repository level, falls back to the organization-level + setting. + type: boolean + sub_claim_prefix: + description: The current `sub` claim prefix for this repository. + type: string required: - use_default actions-secret: @@ -224757,6 +227402,180 @@ components: created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' visibility: all + copilot-spaces-organization-list: + summary: Example response for listing organization copilot spaces + value: + spaces: + - id: 84 + number: 3 + name: Team Planning Space + description: Organization space for team planning and coordination + owner: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + gravatar_id: '' + name: octo-org + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: octo-org + html_url: https://github.com/octo-org + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + creator: + login: defunkt + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://github.com/images/error/defunkt_happy.gif + gravatar_id: '' + url: https://api.github.com/users/defunkt + html_url: https://github.com/defunkt + followers_url: https://api.github.com/users/defunkt/followers + following_url: https://api.github.com/users/defunkt/following{/other_user} + gists_url: https://api.github.com/users/defunkt/gists{/gist_id} + starred_url: https://api.github.com/users/defunkt/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/defunkt/subscriptions + organizations_url: https://api.github.com/users/defunkt/orgs + repos_url: https://api.github.com/users/defunkt/repos + events_url: https://api.github.com/users/defunkt/events{/privacy} + received_events_url: https://api.github.com/users/defunkt/received_events + type: User + site_admin: true + created_at: '2023-02-15T08:30:00Z' + updated_at: '2023-02-15T14:45:00Z' + html_url: https://github.com/copilot/spaces/octo-org/3 + api_url: https://api.github.com/organizations/1/copilot-spaces/3 + - id: 85 + number: 4 + name: Development Resources + description: Shared development documentation and resources + owner: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + gravatar_id: '' + name: octo-org + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: octo-org + html_url: https://github.com/octo-org + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + creator: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-16T10:15:00Z' + updated_at: '2023-02-16T16:30:00Z' + html_url: https://github.com/copilot/spaces/octo-org/4 + api_url: https://api.github.com/organizations/1/copilot-spaces/4 + copilot-space-organization: + summary: Example response for an organization copilot space + value: + id: 84 + number: 3 + name: Team Planning Space + description: Organization space for team planning and coordination + general_instructions: Help the team with agile planning, sprint coordination, + and project management best practices + owner: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + gravatar_id: '' + name: octo-org + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: octo-org + html_url: https://github.com/octo-org + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + creator: + login: defunkt + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://github.com/images/error/defunkt_happy.gif + gravatar_id: '' + url: https://api.github.com/users/defunkt + html_url: https://github.com/defunkt + followers_url: https://api.github.com/users/defunkt/followers + following_url: https://api.github.com/users/defunkt/following{/other_user} + gists_url: https://api.github.com/users/defunkt/gists{/gist_id} + starred_url: https://api.github.com/users/defunkt/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/defunkt/subscriptions + organizations_url: https://api.github.com/users/defunkt/orgs + repos_url: https://api.github.com/users/defunkt/repos + events_url: https://api.github.com/users/defunkt/events{/privacy} + received_events_url: https://api.github.com/users/defunkt/received_events + type: User + site_admin: true + created_at: '2023-02-15T08:30:00Z' + updated_at: '2023-02-15T14:45:00Z' + html_url: https://github.com/copilot/spaces/octo-org/3 + api_url: https://api.github.com/organizations/1/copilot-spaces/3 + base_role: no_access + resources_attributes: + - id: 123 + resource_type: github_file + metadata: + repository_id: 456 + file_path: docs/planning.md + - id: 124 + resource_type: free_text + metadata: + name: Team Guidelines + text: Our team follows agile methodology copilot-organization-details: value: seat_breakdown: @@ -244748,6 +247567,165 @@ components: space: 976562499 collaborators: 0 private_repos: 9999 + copilot-spaces-user-list: + summary: Example response for listing user copilot spaces + value: + spaces: + - id: 42 + number: 1 + name: Personal Research Space + description: My personal space for research and development + owner: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-16T10:15:00Z' + updated_at: '2023-02-16T16:30:00Z' + html_url: https://github.com/copilot/spaces/octocat/1 + api_url: https://api.github.com/user/1/copilot-spaces/1 + - id: 43 + number: 2 + name: Learning Space + description: Space for learning new technologies + owner: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-17T08:20:00Z' + updated_at: '2023-02-17T14:45:00Z' + html_url: https://github.com/copilot/spaces/octocat/2 + api_url: https://api.github.com/user/1/copilot-spaces/2 + copilot-space-user: + summary: Example response for a user copilot space + value: + id: 42 + number: 5 + name: My Development Space + description: Personal space for React development patterns + general_instructions: Focus on React functional components, hooks, and modern + development patterns + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-15T08:30:00Z' + updated_at: '2023-02-15T14:45:00Z' + html_url: https://github.com/copilot/spaces/octocat/5 + api_url: https://api.github.com/user/1/copilot-spaces/5 + base_role: no_access + resources_attributes: + - id: 789 + resource_type: github_file + metadata: + repository_id: 1234 + file_path: src/components/App.tsx + - id: 790 + resource_type: free_text + metadata: + name: React Best Practices + text: Use functional components with hooks user-events-items: value: - id: '22249084947' diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index c1e04b71c3..bc80497d4c 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -136,6 +136,10 @@ "name": "users", "description": "Interact with and view information about users and also current user." }, + { + "name": "code-quality", + "description": "Insights into reliability, maintainability, and efficiency of your codebase." + }, { "name": "codespaces", "description": "Endpoints to manage Codespaces using the REST API." @@ -144,6 +148,10 @@ "name": "copilot", "description": "Endpoints to manage Copilot using the REST API." }, + { + "name": "copilot-spaces", + "description": "Endpoints to manage Copilot Spaces using the REST API." + }, { "name": "security-advisories", "description": "Manage security advisories." @@ -5712,7 +5720,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -6852,7 +6860,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7765,7 +7773,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -8243,7 +8251,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -10598,7 +10606,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -11770,7 +11778,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -12806,7 +12814,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -13545,7 +13553,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -24738,7 +24746,7 @@ "/enterprises/{enterprise}/copilot/policies/coding_agent": { "put": { "summary": "Set the coding agent policy for an enterprise", - "description": "Sets the policy for Copilot coding agent usage across an enterprise.\n\nEnterprise owners can configure whether Copilot coding agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.\n\nOnly enterprise owners can set the coding agent policy for their enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "description": "Sets the policy for Copilot cloud agent usage across an enterprise.\n\nEnterprise owners can configure whether Copilot cloud agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.\n\nOnly enterprise owners can set the coding agent policy for their enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -24768,7 +24776,7 @@ "properties": { "policy_state": { "type": "string", - "description": "The policy state for Copilot coding agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.", + "description": "The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.", "enum": [ "enabled_for_all_orgs", "disabled_for_all_orgs", @@ -24875,7 +24883,7 @@ "/enterprises/{enterprise}/copilot/policies/coding_agent/organizations": { "post": { "summary": "Add organizations to the enterprise coding agent policy", - "description": "Enables Copilot coding agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can add organizations to the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "description": "Enables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can add organizations to the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -24896,7 +24904,7 @@ } ], "requestBody": { - "description": "The organizations to enable Copilot coding agent for", + "description": "The organizations to enable Copilot cloud agent for", "required": true, "content": { "application/json": { @@ -24905,7 +24913,7 @@ "properties": { "organizations": { "type": "array", - "description": "List of organization logins within the enterprise to enable Copilot coding agent for.", + "description": "List of organization logins within the enterprise to enable Copilot cloud agent for.", "items": { "type": "string" } @@ -25040,7 +25048,7 @@ }, "delete": { "summary": "Remove organizations from the enterprise coding agent policy", - "description": "Disables Copilot coding agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can remove organizations from the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "description": "Disables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can remove organizations from the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -25061,7 +25069,7 @@ } ], "requestBody": { - "description": "The organizations to disable Copilot coding agent for", + "description": "The organizations to disable Copilot cloud agent for", "required": true, "content": { "application/json": { @@ -25070,7 +25078,7 @@ "properties": { "organizations": { "type": "array", - "description": "List of organization logins within the enterprise to disable Copilot coding agent for.", + "description": "List of organization logins within the enterprise to disable Copilot cloud agent for.", "items": { "type": "string" } @@ -91517,6 +91525,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } }, "required": [ @@ -91580,6 +91592,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } } }, @@ -124576,17 +124592,17 @@ } } }, - "/orgs/{org}/copilot/billing": { + "/orgs/{org}/copilot-spaces": { "get": { - "summary": "Get Copilot seat information and settings for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "summary": "List organization Copilot Spaces", + "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/get-copilot-organization-details", + "operationId": "copilot-spaces/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-organization-copilot-spaces" }, "parameters": [ { @@ -124597,288 +124613,32 @@ "schema": { "type": "string" } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "title": "Copilot Organization Details", - "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.", - "type": "object", - "properties": { - "seat_breakdown": { - "title": "Copilot Seat Breakdown", - "description": "The breakdown of Copilot Business seats for the organization.", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "The total number of seats being billed for the organization as of the current billing cycle." - }, - "added_this_cycle": { - "type": "integer", - "description": "Seats added during the current billing cycle." - }, - "pending_cancellation": { - "type": "integer", - "description": "The number of seats that are pending cancellation at the end of the current billing cycle." - }, - "pending_invitation": { - "type": "integer", - "description": "The number of users who have been invited to receive a Copilot seat through this organization." - }, - "active_this_cycle": { - "type": "integer", - "description": "The number of seats that have used Copilot during the current billing cycle." - }, - "inactive_this_cycle": { - "type": "integer", - "description": "The number of seats that have not used Copilot during the current billing cycle." - } - } - }, - "public_code_suggestions": { - "type": "string", - "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).", - "enum": [ - "allow", - "block", - "unconfigured" - ] - }, - "ide_chat": { - "type": "string", - "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] - }, - "platform_chat": { - "type": "string", - "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] - }, - "cli": { - "type": "string", - "description": "The organization policy for allowing or disallowing Copilot CLI.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] - }, - "seat_management_setting": { - "type": "string", - "description": "The mode of assigning new seats.", - "enum": [ - "assign_all", - "assign_selected", - "disabled", - "unconfigured" - ] - }, - "plan_type": { - "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", - "enum": [ - "business", - "enterprise" - ] - } - }, - "required": [ - "seat_breakdown", - "public_code_suggestions", - "seat_management_setting" - ], - "additionalProperties": true - }, - "examples": { - "default": { - "value": { - "seat_breakdown": { - "total": 12, - "added_this_cycle": 9, - "pending_invitation": 0, - "pending_cancellation": 0, - "active_this_cycle": 12, - "inactive_this_cycle": 11 - }, - "seat_management_setting": "assign_selected", - "ide_chat": "enabled", - "platform_chat": "enabled", - "cli": "enabled", - "public_code_suggestions": "block", - "plan_type": "business" - } - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "There is a problem with your account's associated payment method." - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" - } - } - }, - "/orgs/{org}/copilot/billing/seats": { - "get": { - "summary": "List all Copilot seat assignments for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/list-copilot-seats", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" - }, - "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 } }, { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", "in": "query", "schema": { - "type": "integer", - "default": 1 + "type": "string" } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", "in": "query", "schema": { - "type": "integer", - "default": 50 + "type": "string" } } ], @@ -124889,23 +124649,76 @@ "application/json": { "schema": { "type": "object", + "required": [ + "spaces" + ], "properties": { - "total_seats": { - "type": "integer", - "description": "Total number of Copilot seats for the organization currently being billed." - }, - "seats": { + "spaces": { "type": "array", + "description": "The list of Copilot Spaces on this page of results.", "items": { - "title": "Copilot Business Seat Detail", - "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", "type": "object", "properties": { - "assignee": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { "anyOf": [ - { - "type": "null" - }, { "title": "Simple User", "description": "A GitHub user.", @@ -125073,13 +124886,6 @@ "type", "url" ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" }, { "title": "Organization Simple", @@ -125180,412 +124986,312 @@ "description" ] } - ] + ], + "description": "The user or organization that owns this space." }, - "assigning_team": { - "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", - "oneOf": [ - { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - { - "title": "Enterprise Team", - "description": "Group of enterprise owners and/or members", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "sync_to_organizations": { - "type": "string", - "description": "Retired: this field will not be returned with GHEC enterprise teams.", - "examples": [ - "disabled | all" - ] - }, - "organization_selection_type": { - "type": "string", - "examples": [ - "disabled | selected | all" - ] - }, - "group_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "62ab9291-fae2-468e-974b-7e45096d5021" - ] - }, - "group_name": { - "type": [ - "string", - "null" - ], - "description": "Retired: this field will not be returned with GHEC enterprise teams.", - "examples": [ - "Justice League" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/dc/teams/justice-league" - ] - }, - "members_url": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "url", - "members_url", - "name", - "html_url", - "slug", - "created_at", - "updated_at", - "group_id" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } - ], - "type": [ - "null", - "object" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "pending_cancellation_date": { - "type": [ - "string", - "null" - ], - "format": "date", - "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." - }, - "last_activity_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." - }, - "last_activity_editor": { - "type": [ - "string", - "null" - ], - "description": "Last editor that was used by the user for a GitHub Copilot completion." - }, - "last_authenticated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format." - }, "created_at": { "type": "string", "format": "date-time", - "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] }, "updated_at": { "type": "string", "format": "date-time", - "deprecated": true, - "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] }, - "plan_type": { + "html_url": { "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", - "enum": [ - "business", - "enterprise", - "unknown" + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } } }, "required": [ - "created_at" + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" ], "additionalProperties": false } @@ -125594,21 +125300,98 @@ }, "examples": { "default": { + "summary": "Example response for listing organization copilot spaces", "value": { - "total_seats": 2, - "seats": [ + "spaces": [ { - "created_at": "2021-08-03T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": null, - "last_activity_at": "2021-10-14T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "last_authenticated_at": "2021-10-14T00:53:32-06:00", - "plan_type": "business", - "assignee": { - "login": "octocat", + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "owner": { + "login": "octo-org", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3" + }, + { + "id": 85, + "number": 4, + "name": "Development Resources", + "description": "Shared development documentation and resources", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", @@ -125625,49 +125408,10 @@ "type": "User", "site_admin": false }, - "assigning_team": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - }, - { - "created_at": "2021-09-23T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": "2021-11-01", - "last_activity_at": "2021-10-13T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "last_authenticated_at": "2021-10-14T00:53:32-06:00", - "assignee": { - "login": "octokitten", - "id": 1, - "node_id": "MDQ76VNlcjE=", - "avatar_url": "https://github.com/images/error/octokitten_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octokitten", - "html_url": "https://github.com/octokitten", - "followers_url": "https://api.github.com/users/octokitten/followers", - "following_url": "https://api.github.com/users/octokitten/following{/other_user}", - "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", - "organizations_url": "https://api.github.com/users/octokitten/orgs", - "repos_url": "https://api.github.com/users/octokitten/repos", - "events_url": "https://api.github.com/users/octokitten/events{/privacy}", - "received_events_url": "https://api.github.com/users/octokitten/received_events", - "type": "User", - "site_admin": false - } + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/4", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/4" } ] } @@ -125684,58 +125428,6 @@ } } }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "403": { "description": "Forbidden", "content": { @@ -125790,24 +125482,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } - } - }, - "/orgs/{org}/copilot/billing/selected_teams": { + }, "post": { - "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "summary": "Create an organization Copilot Space", + "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/add-copilot-seats-for-teams", + "operationId": "copilot-spaces/create-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-an-organization-copilot-space" }, "parameters": [ { @@ -125821,292 +125510,855 @@ } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "selected_teams": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "Team Planning Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Organization space for team planning and coordination" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help the team with planning and coordination tasks" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions for organization members.\n- `no_access`: No default access (default)\n- `reader`: Organization members can read the space\n- `writer`: Organization members can read and edit the space\n- `admin`: Organization members have full admin access to the space", + "default": "no_access" + }, + "resources_attributes": { "type": "array", - "description": "List of team names within the organization to which to grant access to GitHub Copilot.", + "description": "Resources to attach to the space.", "items": { - "type": "string" - }, - "minItems": 1 + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } } }, "required": [ - "selected_teams" + "name" ] }, "examples": { "default": { "value": { - "selected_teams": [ - "engteam1", - "engteam2", - "engteam3" + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/planning.md" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology and holds daily standups" + } + } ] } } } } - }, - "required": true + } }, "responses": { "201": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats created for members of the specified team(s).", - "properties": { - "seats_created": { - "type": "integer" - } - }, - "required": [ - "seats_created" - ] - }, - "examples": { - "default": { - "value": { - "seats_created": 5 - } - } - } - } - } - }, - "500": { - "description": "Internal Error", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] }, - "url": { - "type": "string" + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] }, - "documentation_url": { - "type": "string" + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] }, - "url": { - "type": "string" + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] }, - "documentation_url": { - "type": "string" + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." }, - "url": { - "type": "string" + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] }, - "documentation_url": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] }, - "url": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" - } - }, - "delete": { - "summary": "Remove teams from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/cancel-copilot-seat-assignment-for-teams", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_teams": { - "type": "array", - "description": "The names of teams from which to revoke access to GitHub Copilot.", - "items": { - "type": "string" + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] }, - "minItems": 1 - } - }, - "required": [ - "selected_teams" - ] - }, - "examples": { - "default": { - "value": { - "selected_teams": [ - "engteam1", - "engteam2", - "engteam3" - ] - } - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", - "properties": { - "seats_cancelled": { - "type": "integer" + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } } }, "required": [ - "seats_cancelled" - ] + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false }, "examples": { "default": { + "summary": "Example response for an organization copilot space", "value": { - "seats_cancelled": 5 - } - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] } } } } } }, - "401": { - "description": "Requires authentication", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -126131,8 +126383,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -126157,14 +126409,18 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -126172,40 +126428,81 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } } }, - "/orgs/{org}/copilot/billing/selected_users": { - "post": { - "summary": "Add users to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "/orgs/{org}/copilot-spaces/{space_number}": { + "get": { + "summary": "Get an organization Copilot Space", + "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/add-copilot-seats-for-users", + "operationId": "copilot-spaces/get-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-an-organization-copilot-space" }, "parameters": [ { @@ -126216,313 +126513,738 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_usernames": { - "type": "array", - "description": "The usernames of the organization members to be granted access to GitHub Copilot.", - "items": { - "type": "string" - }, - "minItems": 1 - } - }, - "required": [ - "selected_usernames" - ] - }, - "examples": { - "default": { - "value": { - "selected_usernames": [ - "cooluser1", - "hacker2", - "octocat" - ] - } - } - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats created for the specified user(s).", - "properties": { - "seats_created": { - "type": "integer" - } - }, - "required": [ - "seats_created" - ] - }, - "examples": { - "default": { - "value": { - "seats_created": 5 - } - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" - } - }, - "delete": { - "summary": "Remove users from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/cancel-copilot-seat-assignment-for-users", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization" - }, - "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_usernames": { - "type": "array", - "description": "The usernames of the organization members for which to revoke access to GitHub Copilot.", - "items": { - "type": "string" - }, - "minItems": 1 - } - }, - "required": [ - "selected_usernames" - ] - }, - "examples": { - "default": { - "value": { - "selected_usernames": [ - "cooluser1", - "hacker2", - "octocat" - ] - } - } - } - } - }, - "required": true - }, "responses": { "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats set to \"pending cancellation\" for the specified users.", - "properties": { - "seats_cancelled": { - "type": "integer" - } - }, - "required": [ - "seats_cancelled" - ] - }, - "examples": { - "default": { - "value": { - "seats_cancelled": 5 - } - } - } - } - } - }, - "500": { - "description": "Internal Error", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] }, - "documentation_url": { - "type": "string" + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] }, - "url": { - "type": "string" + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] }, - "documentation_url": { - "type": "string" + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] }, - "url": { - "type": "string" + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] }, - "status": { - "type": "string" + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + }, + "examples": { + "default": { + "summary": "Example response for an organization copilot space", + "value": { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] } } } @@ -126580,30 +127302,24 @@ } } } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team." } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } - } - }, - "/orgs/{org}/copilot/coding-agent/permissions": { - "get": { - "summary": "Get Copilot coding agent permissions for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about which repositories in an organization have been enabled\nor disabled for the Copilot coding agent.\n\nOrganization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + }, + "put": { + "summary": "Set an organization Copilot Space", + "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/get-copilot-coding-agent-permissions-organization", + "operationId": "copilot-spaces/update-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-an-organization-copilot-space" }, "parameters": [ { @@ -126614,86 +127330,868 @@ "schema": { "type": "string" } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "Updated Team Planning Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Updated organization space for team planning and coordination" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Updated instructions to help the team with planning and coordination tasks" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions for organization members. Changing this field requires admin permissions.\n- `no_access`: No default access (default)\n- `reader`: Organization members can read the space\n- `writer`: Organization members can read and edit the space\n- `admin`: Organization members have full admin access to the space" + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "Updated Team Planning Space", + "description": "Updated organization space for team planning and coordination", + "general_instructions": "Updated instructions to help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/updated-planning.md" + } + }, + { + "id": 789, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Team Guidelines", + "text": "Our updated team follows agile methodology and holds daily standups" + } + } + ] + } + } + } + } + } + }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", "type": "object", "properties": { - "enabled_repositories": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", "enum": [ - "all", - "selected", - "none" + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" ] }, - "selected_repositories_url": { + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { "type": "string", - "description": "The URL for the selected repositories endpoint. Only present when `enabled_repositories` is `selected`." + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } } }, "required": [ - "enabled_repositories" - ] + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false }, "examples": { - "all_enabled": { - "summary": "All repositories enabled", - "value": { - "enabled_repositories": "all" - } - }, - "selected_enabled": { - "summary": "Selected repositories enabled", - "value": { - "enabled_repositories": "selected", - "selected_repositories_url": "https://api.github.com/orgs/my-org/copilot/coding-agent/permissions/repositories" - } - }, - "none_enabled": { - "summary": "No repositories enabled", + "default": { + "summary": "Example response for an organization copilot space", "value": { - "enabled_repositories": "none" - } - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] } } } } } }, - "401": { - "description": "Requires authentication", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -126718,8 +128216,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -126744,14 +128242,18 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -126759,11 +128261,56 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -126772,22 +128319,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } }, - "put": { - "summary": "Set Copilot coding agent permissions for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets the policy for which repositories in an organization can use Copilot coding agent.\n\nOrganization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "delete": { + "summary": "Delete an organization Copilot Space", + "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/set-copilot-coding-agent-permissions-organization", + "operationId": "copilot-spaces/delete-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-an-organization-copilot-space" }, "parameters": [ { @@ -126798,120 +128344,20 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "enabled_repositories": { - "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", - "enum": [ - "all", - "selected", - "none" - ] - } - }, - "required": [ - "enabled_repositories" - ] - }, - "examples": { - "default": { - "value": { - "enabled_repositories": "selected" - } - } - } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } - }, + ], "responses": { "204": { - "description": "No Content" - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } + "description": "The Copilot Space has been successfully deleted." }, "404": { "description": "Resource not found", @@ -127016,24 +128462,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } } }, - "/orgs/{org}/copilot/coding-agent/permissions/repositories": { + "/orgs/{org}/copilot-spaces/{space_number}/collaborators": { "get": { - "summary": "List repositories enabled for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists the selected repositories that are enabled for Copilot coding agent in an organization.\n\nOrganization owners can use this endpoint when the coding agent repository policy\nis set to `selected` to see which repositories have been enabled.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "List collaborators for an organization Copilot Space", + "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/list-copilot-coding-agent-selected-repositories-for-organization", + "operationId": "copilot-spaces/list-collaborators-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-an-organization-copilot-space" }, "parameters": [ { @@ -127046,21 +128491,12 @@ } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], @@ -127071,1195 +128507,375 @@ "application/json": { "schema": { "type": "object", + "required": [ + "collaborators" + ], "properties": { - "total_count": { - "type": "integer" - }, - "repositories": { + "collaborators": { "type": "array", + "description": "The list of collaborators for this Copilot Space.", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." }, - "login": { + "role": { "type": "string", - "examples": [ - "octocat" - ] + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" }, "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "type": "integer" }, "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "type": "string" }, - "avatar_url": { + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "enum": [ + "Team" ] }, - "gravatar_id": { + "description": { "type": [ "string", "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" ] }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "privacy": { + "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "notification_setting": { + "type": "string" }, - "repos_url": { + "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "format": "uri" }, - "events_url": { + "html_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri" }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "members_url": { + "type": "string" }, - "type": { + "repositories_url": { "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" + "format": "uri" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "organization_id": { + "type": "integer" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" + "parent": { + "type": [ + "null" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", + "actor_type", + "role", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "name", + "slug", + "type" ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_bypass": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - }, - "mode": { - "type": "string", - "description": "The bypass mode for the reviewer", - "enum": [ - "ALWAYS", - "EXEMPT" - ], - "default": "ALWAYS" - } - } - } - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" ] } } - }, - "required": [ - "total_count", - "repositories" - ] + } }, "examples": { "default": { "value": { - "total_count": 1, - "repositories": [ + "collaborators": [ { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "octo-org", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "organization": null, - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "template_repository": null, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "delete_branch_on_merge": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "description": "A great organization" + } } ] } @@ -128268,58 +128884,6 @@ } } }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "403": { "description": "Forbidden", "content": { @@ -128371,51 +128935,24 @@ } } } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "collaborators" } }, - "put": { - "summary": "Set selected repositories for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReplaces the list of selected repositories that are enabled for Copilot coding\nagent in an organization. This method can only be called when the coding agent\nrepository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "post": { + "summary": "Add a collaborator to an organization Copilot Space", + "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/set-copilot-coding-agent-selected-repositories-for-organization", + "operationId": "copilot-spaces/add-collaborator-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-an-organization-copilot-space" }, "parameters": [ { @@ -128426,6 +128963,15 @@ "schema": { "type": "string" } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -128434,27 +128980,48 @@ "application/json": { "schema": { "type": "object", + "required": [ + "actor_type", + "actor_identifier", + "role" + ], "properties": { - "selected_repository_ids": { - "description": "List of repository IDs to enable for Copilot coding agent.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - } + "actor_type": { + "type": "string", + "enum": [ + "User", + "Team" + ], + "description": "The type of actor (user or team)." + }, + "actor_identifier": { + "type": "string", + "description": "The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role to grant to the collaborator." } - }, - "required": [ - "selected_repository_ids" - ] + } }, "examples": { - "default": { + "user": { "value": { - "selected_repository_ids": [ - 32, - 42 - ] + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" + } + }, + "team": { + "value": { + "actor_type": "Team", + "actor_identifier": "developers", + "role": "reader" } } } @@ -128462,55 +129029,355 @@ } }, "responses": { - "204": { - "description": "No Content" - }, - "500": { - "description": "Internal Error", + "201": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] }, - "status": { - "type": "string" + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + ] + }, + "examples": { + "user": { + "value": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "team": { + "value": { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 } } } @@ -128569,32 +129436,6 @@ } } }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { @@ -128672,24 +129513,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "collaborators" } } }, - "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}": { + "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { "put": { - "summary": "Enable a repository for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nAdds a repository to the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Set a collaborator role for an organization Copilot Space", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/enable-copilot-coding-agent-for-repository-in-organization", + "operationId": "copilot-spaces/update-collaborator-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-an-organization-copilot-space" }, "parameters": [ { @@ -128702,71 +129542,428 @@ } }, { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { "type": "integer" } + }, + { + "name": "actor_type", + "description": "The type of actor (user or team).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], - "responses": { - "204": { - "description": "No Content" - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "role" + ], + "properties": { + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The new role to grant to the collaborator. Use `no_access` to remove the collaborator." + } + } + }, + "examples": { + "default": { + "value": { + "role": "admin" } } } } - }, - "401": { - "description": "Requires authentication", + } + }, + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] }, - "status": { - "type": "string" + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + }, + "examples": { + "user": { + "value": { + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "team": { + "value": { + "actor_type": "Team", + "role": "admin", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 } } } } } }, + "204": { + "description": "Response when `role` is `no_access` and the collaborator was removed." + }, "403": { "description": "Forbidden", "content": { @@ -128819,32 +130016,6 @@ } } }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { @@ -128922,22 +130093,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "collaborators" } }, "delete": { - "summary": "Disable a repository for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemoves a repository from the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint.", + "summary": "Remove a collaborator from an organization Copilot Space", + "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/disable-copilot-coding-agent-for-repository-in-organization", + "operationId": "copilot-spaces/remove-collaborator-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-an-organization-copilot-space" }, "parameters": [ { @@ -128950,70 +130120,40 @@ } }, { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { "type": "integer" } - } - ], - "responses": { - "204": { - "description": "No Content" }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } + { + "name": "actor_type", + "description": "The type of actor (user or team).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] } }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } + { + "name": "actor_identifier", + "description": "The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" } + } + ], + "responses": { + "204": { + "description": "Response" }, "403": { "description": "Forbidden", @@ -129066,53 +130206,26 @@ } } } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "collaborators" } } }, - "/orgs/{org}/copilot/content_exclusion": { + "/orgs/{org}/copilot-spaces/{space_number}/resources": { "get": { - "summary": "Get Copilot content exclusion rules for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot content exclusion path rules.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can view details about Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `copilot` or `read:org` scopes to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.\n> * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.", + "summary": "List resources for an organization Copilot Space", + "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/copilot-content-exclusion-for-organization", + "operationId": "copilot-spaces/list-resources-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-an-organization-copilot-space" }, "parameters": [ { @@ -129123,30 +130236,112 @@ "schema": { "type": "string" } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { "200": { - "description": "OK", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Copilot Organization Content Exclusion Details", - "description": "List all Copilot Content Exclusion rules for an organization.", "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string", - "description": "The path to the file that will be excluded." + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } } } }, "examples": { "default": { "value": { - "octo-repo": [ - "/src/some-dir/kernel.rs" + "resources": [ + { + "id": 1, + "resource_type": "repository", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42 + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + { + "id": 2, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } ] } } @@ -129154,8 +130349,8 @@ } } }, - "500": { - "description": "Internal Error", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -129180,60 +130375,8 @@ } } }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -129260,22 +130403,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-content-exclusion-management" + "category": "copilot-spaces", + "subcategory": "resources" } }, - "put": { - "summary": "Set Copilot content exclusion rules for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets Copilot content exclusion path rules for an organization.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can set Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.\n> * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.", + "post": { + "summary": "Create a resource for an organization Copilot Space", + "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/set-copilot-content-exclusion-for-organization", + "operationId": "copilot-spaces/create-resource-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-an-organization-copilot-space" }, "parameters": [ { @@ -129286,64 +130428,72 @@ "schema": { "type": "string" } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { - "description": "The content exclusion rules to set", "required": true, "content": { "application/json": { "schema": { "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string", - "description": "The path to the file that will be excluded." - }, - { - "type": "object", - "properties": { - "ifAnyMatch": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "ifAnyMatch" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ifNoneMatch": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "ifNoneMatch" - ], - "additionalProperties": false - } - ] + "required": [ + "resource_type", + "metadata" + ], + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ], + "description": "The type of resource to create." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata.", + "additionalProperties": true } } }, "examples": { - "default": { - "summary": "Example of content exclusion paths", + "free_text": { "value": { - "octo-repo": [ - "/src/some-dir/kernel.rs" - ] + "resource_type": "free_text", + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + } + } + }, + "repository": { + "value": { + "resource_type": "repository", + "metadata": { + "repository_id": 42 + } + } + }, + "github_file": { + "value": { + "resource_type": "github_file", + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + } } } } @@ -129351,74 +130501,151 @@ } }, "responses": { - "200": { - "description": "Success", + "201": { + "description": "Resource created", "content": { "application/json": { "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." } - } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] }, "examples": { "default": { "value": { - "message": "Content exclusion rules updated successfully." + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" } } } } } }, - "500": { - "description": "Internal Error", + "200": { + "description": "Duplicate github_file resource already exists", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "id": { + "type": "integer", + "description": "The unique identifier of the resource." }, - "url": { - "type": "string" + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." }, - "documentation_url": { - "type": "string" + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true }, - "url": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." }, - "status": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "github_file", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" } } } @@ -129477,39 +130704,13 @@ } } }, - "413": { - "description": "Payload Too Large", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Validation Error", + "description": "Validation Error", "type": "object", "required": [ "message", @@ -129525,7 +130726,52 @@ "errors": { "type": "array", "items": { - "type": "string" + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } } } } @@ -129535,24 +130781,23 @@ } }, "x-github": { - "githubCloudOnly": null, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-content-exclusion-management" + "category": "copilot-spaces", + "subcategory": "resources" } } }, - "/orgs/{org}/copilot/metrics": { + "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": { "get": { - "summary": "Get Copilot metrics for an organization", - "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "summary": "Get a resource for an organization Copilot Space", + "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/copilot-metrics-for-organization", + "operationId": "copilot-spaces/get-resource-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-an-organization-copilot-space" }, "parameters": [ { @@ -129565,39 +130810,21 @@ } }, { - "name": "since", - "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "until", - "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } }, { - "name": "per_page", - "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 100 + "type": "integer" } } ], @@ -129607,504 +130834,70 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Copilot Usage Metrics", - "description": "Copilot usage metrics for a given day.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "total_engaged_users": { - "type": "integer", - "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "copilot_ide_code_completions": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." - } - } - } - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot code completion metrics for active editors.", - "additionalProperties": true, - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages, for the given editor.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions, for the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_suggestions": { - "type": "integer", - "description": "The number of Copilot code suggestions generated for the given editor, for the given language." - }, - "total_code_acceptances": { - "type": "integer", - "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." - }, - "total_code_lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." - } - } - } - } - } - } - } - } - } - } - } - }, - "copilot_ide_chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in the IDE.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat in the IDE." - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot Chat metrics, for active editors.", - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the specified editor." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the given editor and model." - }, - "total_chats": { - "type": "integer", - "description": "The total number of chats initiated by users in the given editor and model." - }, - "total_chat_insertion_events": { - "type": "integer", - "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." - }, - "total_chat_copy_events": { - "type": "integer", - "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." - } - } - } - } - } - } - } - } - }, - "copilot_dotcom_chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in GitHub.com", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once." - }, - "models": { - "type": "array", - "description": "List of model metrics for a custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model (if applicable)." - }, - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." - }, - "total_chats": { - "type": "integer", - "description": "Total number of chats initiated by users on github.com." - } - } - } - } - } - }, - "copilot_dotcom_pull_requests": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot for pull requests.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." - }, - "repositories": { - "type": "array", - "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Repository name" - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_pr_summaries_created": { - "type": "integer", - "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." - } - } - } - } - } - } - } - } - } - }, - "required": [ - "date" - ], - "additionalProperties": true - } - }, - "examples": { - "default": { - "value": [ - { - "date": "2024-06-24", - "total_active_users": 24, - "total_engaged_users": 20, - "copilot_ide_code_completions": { - "total_engaged_users": 20, - "languages": [ - { - "name": "python", - "total_engaged_users": 10 - }, - { - "name": "ruby", - "total_engaged_users": 10 - } - ], - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 13, - "languages": [ - { - "name": "python", - "total_engaged_users": 6, - "total_code_suggestions": 249, - "total_code_acceptances": 123, - "total_code_lines_suggested": 225, - "total_code_lines_accepted": 135 - }, - { - "name": "ruby", - "total_engaged_users": 7, - "total_code_suggestions": 496, - "total_code_acceptances": 253, - "total_code_lines_suggested": 520, - "total_code_lines_accepted": 270 - } - ] - } - ] - }, - { - "name": "neovim", - "total_engaged_users": 7, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "languages": [ - { - "name": "typescript", - "total_engaged_users": 3, - "total_code_suggestions": 112, - "total_code_acceptances": 56, - "total_code_lines_suggested": 143, - "total_code_lines_accepted": 61 - }, - { - "name": "go", - "total_engaged_users": 4, - "total_code_suggestions": 132, - "total_code_acceptances": 67, - "total_code_lines_suggested": 154, - "total_code_lines_accepted": 72 - } - ] - } - ] - } - ] - }, - "copilot_ide_chat": { - "total_engaged_users": 13, - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 12, - "total_chats": 45, - "total_chat_insertion_events": 12, - "total_chat_copy_events": 16 - }, - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_engaged_users": 1, - "total_chats": 10, - "total_chat_insertion_events": 11, - "total_chat_copy_events": 3 - } - ] - } - ] - }, - "copilot_dotcom_chat": { - "total_engaged_users": 14, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 14, - "total_chats": 38 - } - ] - }, - "copilot_dotcom_pull_requests": { - "total_engaged_users": 12, - "repositories": [ - { - "name": "demo/repo1", - "total_engaged_users": 8, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_pr_summaries_created": 6, - "total_engaged_users": 8 - } - ] - }, - { - "name": "demo/repo2", - "total_engaged_users": 4, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_pr_summaries_created": 10, - "total_engaged_users": 4 - } - ] - } - ] - } - } - ] - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "type": "integer", + "description": "The unique identifier of the resource." }, - "documentation_url": { - "type": "string" + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] }, - "url": { - "type": "string" + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." }, - "status": { - "type": "string" + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" } } } @@ -130162,53 +130955,24 @@ } } } - }, - "422": { - "description": "Copilot Usage Metrics API setting is disabled at the organization or enterprise level.", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-metrics" + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/orgs/{org}/copilot/metrics/reports/organization-1-day": { - "get": { - "summary": "Get Copilot organization usage metrics for a specific day", - "description": "Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + }, + "put": { + "summary": "Set a resource for an organization Copilot Space", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/copilot-organization-one-day-usage-metrics", + "operationId": "copilot-spaces/update-resource-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day" + "url": "https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-an-organization-copilot-space" }, "parameters": [ { @@ -130221,67 +130985,129 @@ } }, { - "name": "day", - "description": "The day to request data for, in `YYYY-MM-DD` format.", - "in": "query", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", "required": true, "schema": { - "type": "string", - "format": "date", - "examples": [ - "2025-10-13" - ] + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "Updated resource-specific metadata.", + "additionalProperties": true + } + } + }, + "examples": { + "default": { + "value": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + } + } + } + } + } + }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", "type": "object", - "title": "Copilot Metrics 1 Day Report", - "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", "properties": { - "download_links": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + "id": { + "type": "integer", + "description": "The unique identifier of the resource." }, - "report_day": { + "resource_type": { "type": "string", - "format": "date", - "description": "The day of the report in `YYYY-MM-DD` format." + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." } }, "required": [ - "download_links", - "report_day" + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" ] }, "examples": { "default": { "value": { - "download_links": [ - "https://example.com/copilot-usage-report-1.json", - "https://example.com/copilot-usage-report-2.json" - ], - "report_day": "2025-07-01" + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" } } } } } }, - "204": { - "description": "A header with no content is returned." - }, - "500": { - "description": "Internal Error", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -130306,8 +131132,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -130332,14 +131158,18 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -130347,11 +131177,56 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -130360,24 +131235,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage-metrics" + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest": { - "get": { - "summary": "Get Copilot organization usage metrics", - "description": "Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + }, + "delete": { + "summary": "Delete a resource from an organization Copilot Space", + "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/copilot-organization-usage-metrics", + "operationId": "copilot-spaces/delete-resource-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics" + "url": "https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-an-organization-copilot-space" }, "parameters": [ { @@ -130388,83 +131260,29 @@ "schema": { "type": "string" } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Copilot Metrics 28 Day Report", - "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", - "properties": { - "download_links": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." - }, - "report_start_day": { - "type": "string", - "format": "date", - "description": "The start date of the report period in `YYYY-MM-DD` format." - }, - "report_end_day": { - "type": "string", - "format": "date", - "description": "The end date of the report period in `YYYY-MM-DD` format." - } - }, - "required": [ - "download_links", - "report_start_day", - "report_end_day" - ] - }, - "examples": { - "default": { - "value": { - "download_links": [ - "https://example.com/copilot-usage-report-1.json", - "https://example.com/copilot-usage-report-2.json" - ], - "report_start_day": "2025-07-01", - "report_end_day": "2025-07-28" - } - } - } - } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } + } + ], + "responses": { + "204": { + "description": "Response" }, "403": { "description": "Forbidden", @@ -130520,24 +131338,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage-metrics" + "category": "copilot-spaces", + "subcategory": "resources" } } }, - "/orgs/{org}/copilot/metrics/reports/users-1-day": { + "/orgs/{org}/copilot/billing": { "get": { - "summary": "Get Copilot organization users usage metrics for a specific day", - "description": "Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "summary": "Get Copilot seat information and settings for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], - "operationId": "copilot/copilot-organization-users-one-day-usage-metrics", + "operationId": "copilot/get-copilot-organization-details", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization" }, "parameters": [ { @@ -130548,67 +131365,134 @@ "schema": { "type": "string" } - }, - { - "name": "day", - "description": "The day to request data for, in `YYYY-MM-DD` format.", - "in": "query", - "required": true, - "schema": { - "type": "string", - "format": "date", - "examples": [ - "2025-10-13" - ] - } } ], "responses": { "200": { - "description": "Response", + "description": "OK", "content": { "application/json": { "schema": { + "title": "Copilot Organization Details", + "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.", "type": "object", - "title": "Copilot Metrics 1 Day Report", - "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", "properties": { - "download_links": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + "seat_breakdown": { + "title": "Copilot Seat Breakdown", + "description": "The breakdown of Copilot Business seats for the organization.", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "The total number of seats being billed for the organization as of the current billing cycle." + }, + "added_this_cycle": { + "type": "integer", + "description": "Seats added during the current billing cycle." + }, + "pending_cancellation": { + "type": "integer", + "description": "The number of seats that are pending cancellation at the end of the current billing cycle." + }, + "pending_invitation": { + "type": "integer", + "description": "The number of users who have been invited to receive a Copilot seat through this organization." + }, + "active_this_cycle": { + "type": "integer", + "description": "The number of seats that have used Copilot during the current billing cycle." + }, + "inactive_this_cycle": { + "type": "integer", + "description": "The number of seats that have not used Copilot during the current billing cycle." + } + } }, - "report_day": { + "public_code_suggestions": { "type": "string", - "format": "date", - "description": "The day of the report in `YYYY-MM-DD` format." + "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).", + "enum": [ + "allow", + "block", + "unconfigured" + ] + }, + "ide_chat": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "platform_chat": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "cli": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot CLI.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "seat_management_setting": { + "type": "string", + "description": "The mode of assigning new seats.", + "enum": [ + "assign_all", + "assign_selected", + "disabled", + "unconfigured" + ] + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise" + ] } }, "required": [ - "download_links", - "report_day" - ] + "seat_breakdown", + "public_code_suggestions", + "seat_management_setting" + ], + "additionalProperties": true }, "examples": { "default": { "value": { - "download_links": [ - "https://example.com/copilot-usage-report-1.json", - "https://example.com/copilot-usage-report-2.json" - ], - "report_day": "2025-07-01" + "seat_breakdown": { + "total": 12, + "added_this_cycle": 9, + "pending_invitation": 0, + "pending_cancellation": 0, + "active_this_cycle": 12, + "inactive_this_cycle": 11 + }, + "seat_management_setting": "assign_selected", + "ide_chat": "enabled", + "platform_chat": "enabled", + "cli": "enabled", + "public_code_suggestions": "block", + "plan_type": "business" } } } } } }, - "204": { - "description": "A header with no content is returned." - }, "500": { "description": "Internal Error", "content": { @@ -130635,142 +131519,8 @@ } } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage-metrics" - } - } - }, - "/orgs/{org}/copilot/metrics/reports/users-28-day/latest": { - "get": { - "summary": "Get Copilot organization users usage metrics", - "description": "Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", - "tags": [ - "copilot" - ], - "operationId": "copilot/copilot-organization-users-usage-metrics", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Copilot Metrics 28 Day Report", - "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", - "properties": { - "download_links": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." - }, - "report_start_day": { - "type": "string", - "format": "date", - "description": "The start date of the report period in `YYYY-MM-DD` format." - }, - "report_end_day": { - "type": "string", - "format": "date", - "description": "The end date of the report period in `YYYY-MM-DD` format." - } - }, - "required": [ - "download_links", - "report_start_day", - "report_end_day" - ] - }, - "examples": { - "default": { - "value": { - "download_links": [ - "https://example.com/copilot-usage-report-1.json", - "https://example.com/copilot-usage-report-2.json" - ], - "report_start_day": "2025-07-01", - "report_end_day": "2025-07-28" - } - } - } - } - } - }, - "500": { - "description": "Internal Error", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -130846,27 +131596,30 @@ } } } + }, + "422": { + "description": "There is a problem with your account's associated payment method." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "copilot", - "subcategory": "copilot-usage-metrics" + "subcategory": "copilot-user-management" } } }, - "/orgs/{org}/dependabot/alerts": { + "/orgs/{org}/copilot/billing/seats": { "get": { - "summary": "List Dependabot alerts for an organization", - "description": "Lists Dependabot alerts for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "summary": "List all Copilot seat assignments for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/list-alerts-for-org", + "operationId": "copilot/list-copilot-seats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" }, "parameters": [ { @@ -130879,163 +131632,12 @@ } }, { - "name": "classification", - "in": "query", - "description": "A comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned.\n\nCan be: `malware`, `general`", - "schema": { - "type": "string" - } - }, - { - "name": "state", - "in": "query", - "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`", - "schema": { - "type": "string" - } - }, - { - "name": "severity", - "in": "query", - "description": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`", - "schema": { - "type": "string" - } - }, - { - "name": "ecosystem", - "in": "query", - "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`", - "schema": { - "type": "string" - } - }, - { - "name": "package", - "in": "query", - "description": "A comma-separated list of package names. If specified, only alerts for these packages will be returned.", - "schema": { - "type": "string" - } - }, - { - "name": "epss_percentage", - "in": "query", - "description": "CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.", - "schema": { - "type": "string" - } - }, - { - "name": "artifact_registry_url", - "in": "query", - "description": "A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.", - "schema": { - "type": "string" - } - }, - { - "name": "artifact_registry", - "in": "query", - "description": "A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned.\n\nCan be: `jfrog-artifactory`", - "schema": { - "type": "string" - } - }, - { - "name": "has", - "in": "query", - "description": "Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple `has` filters can be passed to filter for alerts that have all of the values.", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "patch", - "deployment" - ] - } - } - ] - } - }, - { - "name": "assignee", - "in": "query", - "description": "Filter alerts by assignees.\nProvide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users.\nUse `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.", - "schema": { - "type": "string" - } - }, - { - "name": "runtime_risk", - "in": "query", - "description": "A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned.\n\nCan be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement`", - "schema": { - "type": "string" - } - }, - { - "name": "scope", - "in": "query", - "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.", - "schema": { - "type": "string", - "enum": [ - "development", - "runtime" - ] - } - }, - { - "name": "sort", - "in": "query", - "description": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.", - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "epss_percentage" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", - "required": false, "schema": { - "type": "string" + "type": "integer", + "default": 1 } }, { @@ -131044,7 +131646,7 @@ "in": "query", "schema": { "type": "integer", - "default": 30 + "default": 50 } } ], @@ -131054,2299 +131656,70 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "description": "A Dependabot alert.", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the Dependabot alert.", - "readOnly": true, - "enum": [ - "auto_dismissed", - "dismissed", - "fixed", - "open" - ] - }, - "dependency": { - "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "manifest_path": { - "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true - }, - "scope": { - "type": [ - "string", - "null" - ], - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "enum": [ - "development", - "runtime", - null - ] - }, - "relationship": { - "type": [ - "string", - "null" - ], - "description": "The vulnerable dependency's relationship to your project.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.\n", - "readOnly": true, - "enum": [ - "unknown", - "direct", - "transitive", - "inconclusive", - null - ] - } - } - }, - "security_advisory": { + "type": "object", + "properties": { + "total_seats": { + "type": "integer", + "description": "Total number of Copilot seats for the organization currently being billed." + }, + "seats": { + "type": "array", + "items": { + "title": "Copilot Business Seat Detail", + "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, "properties": { - "ghsa_id": { - "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true - }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true - }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - } - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "classification": { - "type": "string", - "description": "The classification of the advisory.", - "readOnly": true, - "enum": [ - "general", - "malware" - ] - }, - "cvss": { - "type": "object", - "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", - "readOnly": true, - "properties": { - "score": { - "type": "number", - "description": "The overall CVSS score of the advisory.", - "minimum": 0, - "maximum": 10, - "readOnly": true + "assignee": { + "anyOf": [ + { + "type": "null" }, - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The full CVSS vector string for the advisory.", - "readOnly": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false - }, - "cvss_severities": { - "type": [ - "object", - "null" - ], - "properties": { - "cvss_v3": { - "type": [ - "object", - "null" - ], + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "vector_string": { + "name": { "type": [ "string", "null" - ], - "description": "The CVSS 3 vector string." + ] }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { + "email": { "type": [ "string", "null" - ], - "description": "The CVSS 4 vector string." + ] }, - "score": { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "number", - "null" - ], - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - } - } - }, - "epss": { - "type": [ - "object", - "null" - ], - "readOnly": true, - "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", - "properties": { - "percentage": { - "type": "number", - "minimum": 0, - "maximum": 100 - }, - "percentile": { - "type": "number", - "minimum": 0, - "maximum": 100 - } - } - }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } - }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { - "type": "object", - "description": "An advisory identifier.", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true - } - }, - "required": [ - "value", - "type" - ], - "additionalProperties": false - } - }, - "references": { - "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, - "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } - }, - "required": [ - "url" - ], - "additionalProperties": false - } - }, - "published_at": { - "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - } - }, - "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", - "severity", - "cvss", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false - }, - "security_vulnerability": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "created_at": { - "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "The reason that the alert was dismissed.", - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment associated with the alert's dismissal.", - "maxLength": 280 - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "auto_dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissal_request": { - "title": "Dependabot alert dismissal request", - "description": "Information about an active dismissal request for this Dependabot alert.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the dismissal request." - }, - "status": { - "type": "string", - "description": "The current status of the dismissal request.", - "enum": [ - "pending", - "approved", - "rejected", - "cancelled" - ] - }, - "requester": { - "type": "object", - "description": "The user who requested the dismissal.", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the user." - }, - "login": { - "type": "string", - "description": "The login name of the user." - } - } - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time when the dismissal request was created." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The API URL to get more information about this dismissal request." - } - } - }, - "assignees": { - "type": "array", - "description": "The users assigned to this alert.", - "readOnly": true, - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" - ] - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - } - }, - "required": [ - "number", - "state", - "dependency", - "security_advisory", - "security_vulnerability", - "url", - "html_url", - "created_at", - "updated_at", - "dismissed_at", - "dismissed_by", - "dismissed_reason", - "dismissed_comment", - "fixed_at", - "repository" - ], - "additionalProperties": false - } - }, - "examples": { - "default": { - "value": [ - { - "number": 2, - "state": "dismissed", - "dependency": { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "manifest_path": "path/to/requirements.txt", - "scope": "runtime" - }, - "security_advisory": { - "ghsa_id": "GHSA-rf4j-j272-fj86", - "cve_id": "CVE-2018-6188", - "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", - "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 2.0.0, < 2.0.2", - "first_patched_version": { - "identifier": "2.0.2" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 1.11.8, < 1.11.10", - "first_patched_version": { - "identifier": "1.11.10" - } - } - ], - "severity": "high", - "cvss": { - "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", - "score": 7.5 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", - "score": 7.5 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", - "score": 8.7 - } - }, - "epss": { - "percentage": 0.00045, - "percentile": "0.16001e0" - }, - "cwes": [ - { - "cwe_id": "CWE-200", - "name": "Exposure of Sensitive Information to an Unauthorized Actor" - } - ], - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-rf4j-j272-fj86" - }, - { - "type": "CVE", - "value": "CVE-2018-6188" - } - ], - "references": [ - { - "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" - }, - { - "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" - }, - { - "url": "https://usn.ubuntu.com/3559-1/" - }, - { - "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" - }, - { - "url": "http://www.securitytracker.com/id/1040422" - } - ], - "published_at": "2018-10-03T21:13:54Z", - "updated_at": "2022-04-26T18:35:37Z", - "withdrawn_at": null - }, - "security_vulnerability": { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 2.0.0, < 2.0.2", - "first_patched_version": { - "identifier": "2.0.2" - } - }, - "url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2", - "html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2", - "created_at": "2022-06-15T07:43:03Z", - "updated_at": "2022-08-23T14:29:47Z", - "dismissed_at": "2022-08-23T14:29:47Z", - "dismissed_by": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "dismissed_reason": "tolerable_risk", - "dismissed_comment": "This alert is accurate but we use a sanitizer.", - "fixed_at": null, - "assignees": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ], - "repository": { - "id": 217723378, - "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", - "name": "octo-repo", - "full_name": "octo-org/octo-repo", - "owner": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "private": true, - "html_url": "https://github.com/octo-org/octo-repo", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octo-org/octo-repo", - "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", - "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", - "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", - "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", - "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", - "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", - "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}" - } - }, - { - "number": 1, - "state": "open", - "dependency": { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "manifest_path": "path/to/requirements.txt", - "scope": "runtime" - }, - "security_advisory": { - "ghsa_id": "GHSA-8f4m-hccc-8qph", - "cve_id": "CVE-2021-20191", - "summary": "Insertion of Sensitive Information into Log File in ansible", - "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": ">= 2.9.0, < 2.9.18", - "first_patched_version": { - "identifier": "2.9.18" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { - "identifier": "2.8.19" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": ">= 2.10.0, < 2.10.7", - "first_patched_version": { - "identifier": "2.10.7" - } - } - ], - "severity": "medium", - "cvss": { - "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", - "score": 5.5 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", - "score": 5.5 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", - "score": 8.5 - } - }, - "cwes": [ - { - "cwe_id": "CWE-532", - "name": "Insertion of Sensitive Information into Log File" - } - ], - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-8f4m-hccc-8qph" - }, - { - "type": "CVE", - "value": "CVE-2021-20191" - } - ], - "references": [ - { - "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" - }, - { - "url": "https://access.redhat.com/security/cve/cve-2021-20191" - }, - { - "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" - } - ], - "published_at": "2021-06-01T17:38:00Z", - "updated_at": "2021-08-12T23:06:00Z", - "withdrawn_at": null - }, - "security_vulnerability": { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { - "identifier": "2.8.19" - } - }, - "url": "https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1", - "html_url": "https://github.com/octo-org/hello-world/security/dependabot/1", - "created_at": "2022-06-14T15:21:52Z", - "updated_at": "2022-06-14T15:21:52Z", - "dismissed_at": null, - "dismissed_by": null, - "dismissed_reason": null, - "dismissed_comment": null, - "fixed_at": null, - "assignees": [], - "repository": { - "id": 664700648, - "node_id": "MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=", - "name": "hello-world", - "full_name": "octo-org/hello-world", - "owner": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "private": true, - "html_url": "https://github.com/octo-org/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octo-org/hello-world", - "archive_url": "https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octo-org/hello-world/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octo-org/hello-world/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octo-org/hello-world/comments{/number}", - "commits_url": "https://api.github.com/repos/octo-org/hello-world/commits{/sha}", - "compare_url": "https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octo-org/hello-world/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octo-org/hello-world/contributors", - "deployments_url": "https://api.github.com/repos/octo-org/hello-world/deployments", - "downloads_url": "https://api.github.com/repos/octo-org/hello-world/downloads", - "events_url": "https://api.github.com/repos/octo-org/hello-world/events", - "forks_url": "https://api.github.com/repos/octo-org/hello-world/forks", - "git_commits_url": "https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}", - "hooks_url": "https://api.github.com/repos/octo-org/hello-world/hooks", - "issue_comment_url": "https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octo-org/hello-world/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octo-org/hello-world/issues{/number}", - "keys_url": "https://api.github.com/repos/octo-org/hello-world/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octo-org/hello-world/labels{/name}", - "languages_url": "https://api.github.com/repos/octo-org/hello-world/languages", - "merges_url": "https://api.github.com/repos/octo-org/hello-world/merges", - "milestones_url": "https://api.github.com/repos/octo-org/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octo-org/hello-world/pulls{/number}", - "releases_url": "https://api.github.com/repos/octo-org/hello-world/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octo-org/hello-world/stargazers", - "statuses_url": "https://api.github.com/repos/octo-org/hello-world/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octo-org/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/hello-world/subscription", - "tags_url": "https://api.github.com/repos/octo-org/hello-world/tags", - "teams_url": "https://api.github.com/repos/octo-org/hello-world/teams", - "trees_url": "https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}" - } - } - ] - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "alerts" - } - } - }, - "/orgs/{org}/dependabot/repository-access": { - "get": { - "summary": "Lists the repositories Dependabot can access in an organization", - "description": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/repository-access-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "in": "query", - "description": "The page number of results to fetch.", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "default": 1 - } - }, - { - "name": "per_page", - "in": "query", - "description": "Number of results per page.", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Dependabot Repository Access Details", - "description": "Information about repositories that Dependabot is able to access in an organization", - "type": "object", - "properties": { - "default_level": { - "type": [ - "string", - "null" - ], - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal", - null - ], - "examples": [ - "internal" - ] - }, - "accessible_repositories": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", + "string", "null" ], "examples": [ @@ -133468,382 +131841,546 @@ "type", "url" ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" ] - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + } + ] + }, + "assigning_team": { + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", + "oneOf": [ + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent", + "type" ] }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" + { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "description": "Retired: this field will not be returned with GHEC enterprise teams.", + "examples": [ + "disabled | all" + ] + }, + "organization_selection_type": { + "type": "string", + "examples": [ + "disabled | selected | all" + ] + }, + "group_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "62ab9291-fae2-468e-974b-7e45096d5021" + ] + }, + "group_name": { + "type": [ + "string", + "null" + ], + "description": "Retired: this field will not be returned with GHEC enterprise teams.", + "examples": [ + "Justice League" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/dc/teams/justice-league" + ] + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "name", + "html_url", + "slug", + "created_at", + "updated_at", + "group_id" ] } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" + ], + "type": [ + "null", + "object" + ] + }, + "pending_cancellation_date": { + "type": [ + "string", + "null" + ], + "format": "date", + "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." + }, + "last_activity_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + }, + "last_activity_editor": { + "type": [ + "string", + "null" + ], + "description": "Last editor that was used by the user for a GitHub Copilot completion." + }, + "last_authenticated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "deprecated": true, + "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise", + "unknown" ] } - ] + }, + "required": [ + "created_at" + ], + "additionalProperties": false } } - }, - "additionalProperties": false + } }, "examples": { "default": { "value": { - "default_level": "public", - "accessible_repositories": [ + "total_seats": 2, + "seats": [ { - "id": 123456, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", - "name": "example-repo", - "full_name": "octocat/example-repo", - "owner": { - "name": "octocat", - "email": "octo@github.com", + "created_at": "2021-08-03T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": null, + "last_activity_at": "2021-10-14T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "last_authenticated_at": "2021-10-14T00:53:32-06:00", + "plan_type": "business", + "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", - "gravatar_id": 1, + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat/example-repo", + "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", @@ -133854,57 +132391,117 @@ "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", - "site_admin": false, - "starred_at": "\"2020-07-09T00:17:55Z\"", - "user_view_type": "default" + "site_admin": false }, - "private": false, - "html_url": "https://github.com/octocat/example-repo", - "description": "This is an example repository.", - "fork": false, - "url": "https://api.github.com/repos/octocat/example-repo", - "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", - "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", - "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", - "events_url": "https://api.github.com/repos/octocat/example-repo/events", - "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", - "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", - "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", - "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", - "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", - "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", - "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", - "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", - "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + "assigning_team": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + }, + { + "created_at": "2021-09-23T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": "2021-11-01", + "last_activity_at": "2021-10-13T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "last_authenticated_at": "2021-10-14T00:53:32-06:00", + "assignee": { + "login": "octokitten", + "id": 1, + "node_id": "MDQ76VNlcjE=", + "avatar_url": "https://github.com/images/error/octokitten_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octokitten", + "html_url": "https://github.com/octokitten", + "followers_url": "https://api.github.com/users/octokitten/followers", + "following_url": "https://api.github.com/users/octokitten/following{/other_user}", + "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", + "organizations_url": "https://api.github.com/users/octokitten/orgs", + "repos_url": "https://api.github.com/users/octokitten/repos", + "events_url": "https://api.github.com/users/octokitten/events{/privacy}", + "received_events_url": "https://api.github.com/users/octokitten/received_events", + "type": "User", + "site_admin": false + } } ] } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } } }, "403": { @@ -133963,20 +132560,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "copilot", + "subcategory": "copilot-user-management" } - }, - "patch": { - "summary": "Updates Dependabot's repository access list for an organization", - "description": "Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.\n\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", + } + }, + "/orgs/{org}/copilot/billing/selected_teams": { + "post": { + "summary": "Add teams to the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/update-repository-access-for-org", + "operationId": "copilot/add-copilot-seats-for-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization" }, "parameters": [ { @@ -133990,65 +132589,117 @@ } ], "requestBody": { - "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "repository_ids_to_add": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "List of repository IDs to add." - }, - "repository_ids_to_remove": { + "selected_teams": { "type": "array", + "description": "List of team names within the organization to which to grant access to GitHub Copilot.", "items": { - "type": "integer" + "type": "string" }, - "description": "List of repository IDs to remove." + "minItems": 1 } }, - "example": { - "repository_ids_to_add": [ - 123, - 456 - ], - "repository_ids_to_remove": [ - 789 - ] - } + "required": [ + "selected_teams" + ] }, "examples": { - "204": { - "summary": "Example with a 'succeeded' status." - }, - "add-example": { - "summary": "Add repositories", - "value": { - "repository_ids_to_add": [ - 123, - 456 - ] - } - }, - "remove-example": { - "summary": "Remove repositories", + "default": { "value": { - "repository_ids_to_remove": [ - 789 + "selected_teams": [ + "engteam1", + "engteam2", + "engteam3" ] } } } } - } + }, + "required": true }, "responses": { - "204": { - "description": "Response" + "201": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The total number of seats created for members of the specified team(s).", + "properties": { + "seats_created": { + "type": "integer" + } + }, + "required": [ + "seats_created" + ] + }, + "examples": { + "default": { + "value": { + "seats_created": 5 + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } }, "403": { "description": "Forbidden", @@ -134101,27 +132752,28 @@ } } } + }, + "422": { + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "copilot", + "subcategory": "copilot-user-management" } - } - }, - "/orgs/{org}/dependabot/repository-access/default-level": { - "put": { - "summary": "Set the default repository access level for Dependabot", - "description": "Sets the default level of repository access Dependabot will have while performing an update. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.\n\nThis operation supports both server-to-server and user-to-server access.", + }, + "delete": { + "summary": "Remove teams from the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/set-repository-access-default-level", + "operationId": "copilot/cancel-copilot-seat-assignment-for-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization" }, "parameters": [ { @@ -134135,42 +132787,117 @@ } ], "requestBody": { - "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "default_level": { - "type": "string", - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal" - ], - "examples": [ - "internal" - ] + "selected_teams": { + "type": "array", + "description": "The names of teams from which to revoke access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 } }, "required": [ - "default_level" + "selected_teams" ] }, "examples": { - "204": { - "summary": "Example with a 'succeeded' status.", + "default": { "value": { - "default_level": "public" + "selected_teams": [ + "engteam1", + "engteam2", + "engteam3" + ] } } } } - } + }, + "required": true }, "responses": { - "204": { - "description": "Response" + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", + "properties": { + "seats_cancelled": { + "type": "integer" + } + }, + "required": [ + "seats_cancelled" + ] + }, + "examples": { + "default": { + "value": { + "seats_cancelled": 5 + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } }, "403": { "description": "Forbidden", @@ -134223,27 +132950,30 @@ } } } + }, + "422": { + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "copilot", + "subcategory": "copilot-user-management" } } }, - "/orgs/{org}/dependabot/secrets": { - "get": { - "summary": "List organization secrets", - "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "/orgs/{org}/copilot/billing/selected_users": { + "post": { + "summary": "Add users to the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/list-org-secrets", + "operationId": "copilot/add-copilot-seats-for-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#list-organization-secrets" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization" }, "parameters": [ { @@ -134254,149 +132984,194 @@ "schema": { "type": "string" } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members to be granted access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "selected_usernames" + ] + }, + "examples": { + "default": { + "value": { + "selected_usernames": [ + "cooluser1", + "hacker2", + "octocat" + ] + } + } + } + } + }, + "required": true + }, "responses": { - "200": { - "description": "Response", + "201": { + "description": "OK", "content": { "application/json": { "schema": { "type": "object", - "required": [ - "total_count", - "secrets" - ], + "description": "The total number of seats created for the specified user(s).", "properties": { - "total_count": { + "seats_created": { "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "title": "Dependabot Secret for an Organization", - "description": "Secrets for GitHub Dependabot for an organization.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" - ] - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - } } - } + }, + "required": [ + "seats_created" + ] }, "examples": { "default": { "value": { - "total_count": 3, - "secrets": [ - { - "name": "MY_ARTIFACTORY_PASSWORD", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2021-12-10T14:59:22Z", - "visibility": "private" - }, - { - "name": "NPM_TOKEN", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2021-12-10T14:59:22Z", - "visibility": "all" - }, - { - "name": "GH_TOKEN", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2021-12-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories" - } - ] + "seats_created": 5 } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } } } } + }, + "422": { + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-user-management" } - } - }, - "/orgs/{org}/dependabot/secrets/public-key": { - "get": { - "summary": "Get an organization public key", - "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + }, + "delete": { + "summary": "Remove users from the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/get-org-public-key", + "operationId": "copilot/cancel-copilot-seat-assignment-for-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization" }, "parameters": [ { @@ -134409,67 +133184,194 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members for which to revoke access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "selected_usernames" + ] + }, + "examples": { + "default": { + "value": { + "selected_usernames": [ + "cooluser1", + "hacker2", + "octocat" + ] + } + } + } + } + }, + "required": true + }, "responses": { "200": { - "description": "Response", + "description": "OK", "content": { "application/json": { "schema": { - "title": "DependabotPublicKey", - "description": "The public key used for setting Dependabot Secrets.", "type": "object", + "description": "The total number of seats set to \"pending cancellation\" for the specified users.", "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string", - "examples": [ - "1234567" - ] - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "examples": [ - "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" - ] + "seats_cancelled": { + "type": "integer" } }, "required": [ - "key_id", - "key" + "seats_cancelled" ] }, "examples": { "default": { "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + "seats_cancelled": 5 + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } + }, + "422": { + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-user-management" } } }, - "/orgs/{org}/dependabot/secrets/{secret_name}": { + "/orgs/{org}/copilot/coding-agent/permissions": { "get": { - "summary": "Get an organization secret", - "description": "Gets a single organization secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Get Copilot cloud agent permissions for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about which repositories in an organization have been enabled\nor disabled for the Copilot cloud agent.\n\nOrganization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/get-org-secret", + "operationId": "copilot/get-copilot-coding-agent-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-cloud-agent-permissions-for-an-organization" }, "parameters": [ { @@ -134480,15 +133382,6 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "responses": { @@ -134497,57 +133390,148 @@ "content": { "application/json": { "schema": { - "title": "Dependabot Secret for an Organization", - "description": "Secrets for GitHub Dependabot for an organization.", "type": "object", "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { + "enabled_repositories": { "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a secret", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", - "private", - "selected" - ], - "type": "string" + "selected", + "none" + ] }, "selected_repositories_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" - ] + "description": "The URL for the selected repositories endpoint. Only present when `enabled_repositories` is `selected`." } }, "required": [ - "name", - "created_at", - "updated_at", - "visibility" + "enabled_repositories" ] }, "examples": { - "default": { + "all_enabled": { + "summary": "All repositories enabled", "value": { - "name": "NPM_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories" + "enabled_repositories": "all" + } + }, + "selected_enabled": { + "summary": "Selected repositories enabled", + "value": { + "enabled_repositories": "selected", + "selected_repositories_url": "https://api.github.com/orgs/my-org/copilot/coding-agent/permissions/repositories" + } + }, + "none_enabled": { + "summary": "No repositories enabled", + "value": { + "enabled_repositories": "none" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -134558,20 +133542,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-coding-agent-management" } }, "put": { - "summary": "Create or update an organization secret", - "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Set Copilot cloud agent permissions for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets the policy for which repositories in an organization can use Copilot cloud agent.\n\nOrganization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/create-or-update-org-secret", + "operationId": "copilot/set-copilot-coding-agent-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-cloud-agent-permissions-for-an-organization" }, "parameters": [ { @@ -134582,15 +133566,6 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { @@ -134600,53 +133575,24 @@ "schema": { "type": "object", "properties": { - "encrypted_value": { - "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint.", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "type": "string", - "description": "ID of the key you used to encrypt the secret." - }, - "visibility": { + "enabled_repositories": { "type": "string", - "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", - "private", - "selected" + "selected", + "none" ] - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", - "items": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "string" - } - ] - } } }, "required": [ - "visibility" + "enabled_repositories" ] }, "examples": { "default": { "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] + "enabled_repositories": "selected" } } } @@ -134654,91 +133600,208 @@ } }, "responses": { - "201": { - "description": "Response when creating a secret", + "204": { + "description": "No Content" + }, + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } } } } }, - "204": { - "description": "Response when updating a secret" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - }, - "delete": { - "summary": "Delete an organization secret", - "description": "Deletes a secret in an organization using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/delete-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } } }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-coding-agent-management" + } + } }, - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { + "/orgs/{org}/copilot/coding-agent/permissions/repositories": { "get": { - "summary": "List selected repositories for an organization secret", - "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "List repositories enabled for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists the selected repositories that are enabled for Copilot cloud agent in an organization.\n\nOrganization owners can use this endpoint when the coding agent repository policy\nis set to `selected` to see which repositories have been enabled.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/list-selected-repos-for-org-secret", + "operationId": "copilot/list-copilot-coding-agent-selected-repositories-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -134751,12 +133814,12 @@ } }, { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 30 } }, { @@ -134767,15 +133830,6 @@ "type": "integer", "default": 1 } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } } ], "responses": { @@ -134785,10 +133839,6 @@ "application/json": { "schema": { "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { "total_count": { "type": "integer" @@ -135727,7 +134777,11 @@ ] } } - } + }, + "required": [ + "total_count", + "repositories" + ] }, "examples": { "default": { @@ -135801,7 +134855,179 @@ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "organization": null, + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 } ] } @@ -135809,25 +135035,155 @@ } } } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-coding-agent-management" } }, "put": { - "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Set selected repositories for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReplaces the list of selected repositories that are enabled for Copilot cloud\nagent in an organization. This method can only be called when the cloud agent\nrepository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/set-selected-repos-for-org-secret", + "operationId": "copilot/set-copilot-coding-agent-selected-repositories-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -135838,15 +135194,6 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { @@ -135857,10 +135204,11 @@ "type": "object", "properties": { "selected_repository_ids": { + "description": "List of repository IDs to enable for Copilot cloud agent.", "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { - "type": "integer" + "type": "integer", + "description": "Unique identifier of the repository." } } }, @@ -135872,7 +135220,8 @@ "default": { "value": { "selected_repository_ids": [ - 64780797 + 32, + 42 ] } } @@ -135882,28 +135231,233 @@ }, "responses": { "204": { - "description": "Response" + "description": "No Content" + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-coding-agent-management" } } }, - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}": { "put": { - "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Enable a repository for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nAdds a repository to the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/add-selected-repo-to-org-secret", + "operationId": "copilot/enable-copilot-coding-agent-for-repository-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -135915,17 +135469,9 @@ "type": "string" } }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, { "name": "repository_id", + "description": "The unique identifier of the repository.", "in": "path", "required": true, "schema": { @@ -135935,29 +135481,231 @@ ], "responses": { "204": { - "description": "No Content when repository was added to the selected list" + "description": "No Content" + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } }, "409": { - "description": "Conflict when visibility type is not set to selected" + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-coding-agent-management" } }, "delete": { - "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Disable a repository for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemoves a repository from the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/remove-selected-repo-from-org-secret", + "operationId": "copilot/disable-copilot-coding-agent-for-repository-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -135970,50 +135718,609 @@ } }, { - "name": "secret_name", - "description": "The name of the secret.", + "name": "repository_id", + "description": "The unique identifier of the repository.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } } }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-coding-agent-management" + } + } + }, + "/orgs/{org}/copilot/content_exclusion": { + "get": { + "summary": "Get Copilot content exclusion rules for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot content exclusion path rules.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can view details about Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `copilot` or `read:org` scopes to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.\n> * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-content-exclusion-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization" + }, + "parameters": [ { - "name": "repository_id", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], "responses": { - "204": { - "description": "Response when repository was removed from the selected list" + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "title": "Copilot Organization Content Exclusion Details", + "description": "List all Copilot Content Exclusion rules for an organization.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string", + "description": "The path to the file that will be excluded." + } + } + }, + "examples": { + "default": { + "value": { + "octo-repo": [ + "/src/some-dir/kernel.rs" + ] + } + } + } + } + } }, - "409": { - "description": "Conflict when visibility type not set to selected" + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-content-exclusion-management" + } + }, + "put": { + "summary": "Set Copilot content exclusion rules for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets Copilot content exclusion path rules for an organization.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can set Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.\n> * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.", + "tags": [ + "copilot" + ], + "operationId": "copilot/set-copilot-content-exclusion-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The content exclusion rules to set", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string", + "description": "The path to the file that will be excluded." + }, + { + "type": "object", + "properties": { + "ifAnyMatch": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "ifAnyMatch" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ifNoneMatch": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "ifNoneMatch" + ], + "additionalProperties": false + } + ] + } + } + }, + "examples": { + "default": { + "summary": "Example of content exclusion paths", + "value": { + "octo-repo": [ + "/src/some-dir/kernel.rs" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Content exclusion rules updated successfully." + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "413": { + "description": "Payload Too Large", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": null, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-content-exclusion-management" } } }, - "/orgs/{org}/docker/conflicts": { + "/orgs/{org}/copilot/metrics": { "get": { - "summary": "Get list of conflicting packages during Docker migration for organization", - "description": "Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", + "summary": "Get Copilot metrics for an organization", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", "tags": [ - "packages" + "copilot" ], - "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", + "operationId": "copilot/copilot-metrics-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" }, "parameters": [ { @@ -136024,6 +136331,42 @@ "schema": { "type": "string" } + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 100 + } } ], "responses": { @@ -136034,1266 +136377,475 @@ "schema": { "type": "array", "items": { - "title": "Package", - "description": "A software package", + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the package.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the package.", - "type": "string", - "examples": [ - "super-linter" - ] - }, - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ], - "examples": [ - "docker" - ] - }, - "url": { + "date": { "type": "string", - "examples": [ - "https://api.github.com/orgs/github/packages/container/super-linter" - ] + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." }, - "html_url": { - "type": "string", - "examples": [ - "https://github.com/orgs/github/packages/container/package/super-linter" - ] + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." }, - "version_count": { - "description": "The number of versions of the package.", + "total_engaged_users": { "type": "integer", - "examples": [ - 1 - ] + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." }, - "visibility": { - "type": "string", - "enum": [ - "private", - "public" + "copilot_ide_code_completions": { + "type": [ + "object", + "null" ], - "examples": [ - "private" - ] + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } }, - "owner": { - "anyOf": [ - { - "type": "null" + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + } } - ] + } }, - "repository": { - "anyOf": [ - { - "type": "null" + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in GitHub.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." }, - { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_bypass": { + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { "type": "object", "properties": { - "status": { + "name": { "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - }, - "mode": { - "type": "string", - "description": "The bypass mode for the reviewer", - "enum": [ - "ALWAYS", - "EXEMPT" - ], - "default": "ALWAYS" - } - } - } + "description": "Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." } } } } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] + } } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" + } } }, "required": [ - "id", - "name", - "package_type", - "visibility", - "url", - "html_url", - "version_count", - "created_at", - "updated_at" - ] + "date" + ], + "additionalProperties": true } }, "examples": { "default": { "value": [ { - "id": 197, - "name": "hello_docker", - "package_type": "container", - "owner": { - "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 + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] }, - "version_count": 1, - "visibility": "private", - "url": "https://api.github.com/orgs/github/packages/container/hello_docker", - "created_at": "2020-05-19T22:19:11Z", - "updated_at": "2020-05-19T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" - }, - { - "id": 198, - "name": "goodbye_docker", - "package_type": "container", - "owner": { - "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 + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] }, - "version_count": 2, - "visibility": "private", - "url": "https://api.github.com/orgs/github/packages/container/goodbye_docker", - "created_at": "2020-05-20T22:19:11Z", - "updated_at": "2020-05-20T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/package/goodbye_docker" + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } } ] } @@ -137301,6 +136853,32 @@ } } }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, "403": { "description": "Forbidden", "content": { @@ -137327,8 +136905,34 @@ } } }, - "401": { - "description": "Requires authentication", + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Copilot Usage Metrics API setting is disabled at the organization or enterprise level.", "content": { "application/json": { "schema": { @@ -137356,23 +136960,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "packages", - "subcategory": "packages" + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" } } }, - "/orgs/{org}/events": { + "/orgs/{org}/copilot/metrics/reports/organization-1-day": { "get": { - "summary": "List public organization events", - "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", + "summary": "Get Copilot organization usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", "tags": [ - "activity" + "copilot" ], - "operationId": "activity/list-public-org-events", + "operationId": "copilot/copilot-organization-one-day-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/activity/events#list-public-organization-events" + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day" }, "parameters": [ { @@ -137385,21 +136989,172 @@ } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", "in": "query", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + } + } + } + } + }, + "204": { + "description": "A header with no content is returned." + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } } }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest": { + "get": { + "summary": "Get Copilot organization usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics" + }, + "parameters": [ { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "string" } } ], @@ -137409,1807 +137164,8820 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Event", - "description": "Event", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": [ - "string", - "null" - ] - }, - "actor": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "name", - "url" - ] + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/users-1-day": { + "get": { + "summary": "Get Copilot organization users usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-users-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" }, - "org": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + } + } + } + } + }, + "204": { + "description": "A header with no content is returned." + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/users-28-day/latest": { + "get": { + "summary": "Get Copilot organization users usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-users-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" }, - "payload": { - "oneOf": [ - { - "title": "CreateEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "full_ref": { - "type": "string" - }, - "master_branch": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "full_ref", - "master_branch", - "pusher_type" - ] - }, - { - "title": "DeleteEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "full_ref": { - "type": "string" - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "full_ref", - "pusher_type" - ] - }, - { - "title": "DiscussionEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "discussion": { - "title": "Discussion", - "description": "A Discussion in a repository.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - }, - "answer_html_url": { - "type": [ - "string", - "null" - ] - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] - }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "locked": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/dependabot/alerts": { + "get": { + "summary": "List Dependabot alerts for an organization", + "description": "Lists Dependabot alerts for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/list-alerts-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "classification", + "in": "query", + "description": "A comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned.\n\nCan be: `malware`, `general`", + "schema": { + "type": "string" + } + }, + { + "name": "state", + "in": "query", + "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`", + "schema": { + "type": "string" + } + }, + { + "name": "severity", + "in": "query", + "description": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`", + "schema": { + "type": "string" + } + }, + { + "name": "ecosystem", + "in": "query", + "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`", + "schema": { + "type": "string" + } + }, + { + "name": "package", + "in": "query", + "description": "A comma-separated list of package names. If specified, only alerts for these packages will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentage", + "in": "query", + "description": "CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "artifact_registry_url", + "in": "query", + "description": "A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "artifact_registry", + "in": "query", + "description": "A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned.\n\nCan be: `jfrog-artifactory`", + "schema": { + "type": "string" + } + }, + { + "name": "has", + "in": "query", + "description": "Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple `has` filters can be passed to filter for alerts that have all of the values.", + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "patch", + "deployment" + ] + } + } + ] + } + }, + { + "name": "assignee", + "in": "query", + "description": "Filter alerts by assignees.\nProvide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users.\nUse `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.", + "schema": { + "type": "string" + } + }, + { + "name": "runtime_risk", + "in": "query", + "description": "A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned.\n\nCan be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement`", + "schema": { + "type": "string" + } + }, + { + "name": "scope", + "in": "query", + "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.", + "schema": { + "type": "string", + "enum": [ + "development", + "runtime" + ] + } + }, + { + "name": "sort", + "in": "query", + "description": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.", + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "epss_percentage" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "description": "A Dependabot alert.", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "state": { + "type": "string", + "description": "The state of the Dependabot alert.", + "readOnly": true, + "enum": [ + "auto_dismissed", + "dismissed", + "fixed", + "open" + ] + }, + "dependency": { + "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true + }, + "scope": { + "type": [ + "string", + "null" + ], + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "enum": [ + "development", + "runtime", + null + ] + }, + "relationship": { + "type": [ + "string", + "null" + ], + "description": "The vulnerable dependency's relationship to your project.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.\n", + "readOnly": true, + "enum": [ + "unknown", + "direct", + "transitive", + "inconclusive", + null + ] + } + } + }, + "security_advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { + "type": "string", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true + }, + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true + }, + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } }, - "state": { - "type": "string", - "description": "The current state of the discussion.\n`converting` means that the discussion is being converted from an issue.\n`transferring` means that the discussion is being transferred from another repository.", - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } }, - "state_reason": { - "description": "The reason for the current state", + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + } + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "classification": { + "type": "string", + "description": "The classification of the advisory.", + "readOnly": true, + "enum": [ + "general", + "malware" + ] + }, + "cvss": { + "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, + "properties": { + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true + }, + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The full CVSS vector string for the advisory.", + "readOnly": true + } + }, + "required": [ + "score", + "vector_string" + ], + "additionalProperties": false + }, + "cvss_severities": { + "type": [ + "object", + "null" + ], + "properties": { + "cvss_v3": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { "type": [ "string", "null" ], - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ], - "examples": [ - "resolved" - ] - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" + "description": "The CVSS 3 vector string." }, - "user": { - "title": "User", + "score": { "type": [ - "object", + "number", "null" ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64", - "examples": [ - 208045946 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDU6TGFiZWwyMDgwNDU5NDY=" - ] - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/labels/bug" - ] - }, - "name": { - "description": "The name of the label.", - "type": "string", - "examples": [ - "bug" - ] - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ], - "examples": [ - "Something isn't working" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string", - "examples": [ - "FFFFFF" - ] - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "examples": [ - true - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "readOnly": true } }, "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "state_reason", - "locked", - "comments", - "created_at", - "updated_at", - "active_lock_reason", - "body" + "vector_string", + "score" ] - } - }, - "required": [ - "action", - "discussion" - ] - }, - { - "title": "IssuesEvent", - "type": "object", - "properties": { - "action": { - "type": "string" }, - "issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", - "type": "object", + "cvss_v4": { + "type": [ + "object", + "null" + ], "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/1" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], - "examples": [ - "not_planned" - ] - }, - "title": { - "description": "Title of the issue", - "type": "string", - "examples": [ - "Widget creation fails in Safari on OS X 10.8" - ] - }, - "body": { - "description": "Contents of the issue", + "vector_string": { "type": [ "string", "null" ], - "examples": [ - "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - }, - "examples": [ - "bug", - "registration" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] + "description": "The CVSS 4 vector string." }, - "closed_at": { + "score": { "type": [ - "string", + "number", "null" ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + } + } + }, + "epss": { + "type": [ + "object", + "null" + ], + "readOnly": true, + "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", + "properties": { + "percentage": { + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "percentile": { + "type": "number", + "minimum": 0, + "maximum": 100 + } + } + }, + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } + }, + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + } + }, + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } + }, + "required": [ + "url" + ], + "additionalProperties": false + } + }, + "published_at": { + "type": "string", + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + }, + "required": [ + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" + ], + "additionalProperties": false + }, + "security_vulnerability": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "dismissed_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason that the alert was dismissed.", + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment associated with the alert's dismissal.", + "maxLength": 280 + }, + "fixed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "auto_dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissal_request": { + "title": "Dependabot alert dismissal request", + "description": "Information about an active dismissal request for this Dependabot alert.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the dismissal request." + }, + "status": { + "type": "string", + "description": "The current status of the dismissal request.", + "enum": [ + "pending", + "approved", + "rejected", + "cancelled" + ] + }, + "requester": { + "type": "object", + "description": "The user who requested the dismissal.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the user." + }, + "login": { + "type": "string", + "description": "The login name of the user." + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time when the dismissal request was created." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The API URL to get more information about this dismissal request." + } + } + }, + "assignees": { + "type": "array", + "description": "The users assigned to this alert.", + "readOnly": true, + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } + }, + "required": [ + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", + "url", + "html_url", + "created_at", + "updated_at", + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at", + "repository" + ], + "additionalProperties": false + } + }, + "examples": { + "default": { + "value": [ + { + "number": 2, + "state": "dismissed", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-rf4j-j272-fj86", + "cve_id": "CVE-2018-6188", + "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", + "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 1.11.8, < 1.11.10", + "first_patched_version": { + "identifier": "1.11.10" + } + } + ], + "severity": "high", + "cvss": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, + "cwes": [ + { + "cwe_id": "CWE-200", + "name": "Exposure of Sensitive Information to an Unauthorized Actor" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-rf4j-j272-fj86" + }, + { + "type": "CVE", + "value": "CVE-2018-6188" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" + }, + { + "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" + }, + { + "url": "https://usn.ubuntu.com/3559-1/" + }, + { + "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" + }, + { + "url": "http://www.securitytracker.com/id/1040422" + } + ], + "published_at": "2018-10-03T21:13:54Z", + "updated_at": "2022-04-26T18:35:37Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + "url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2", + "html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2", + "created_at": "2022-06-15T07:43:03Z", + "updated_at": "2022-08-23T14:29:47Z", + "dismissed_at": "2022-08-23T14:29:47Z", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_reason": "tolerable_risk", + "dismissed_comment": "This alert is accurate but we use a sanitizer.", + "fixed_at": null, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "repository": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "owner": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "private": true, + "html_url": "https://github.com/octo-org/octo-repo", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}" + } + }, + { + "number": 1, + "state": "open", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-8f4m-hccc-8qph", + "cve_id": "CVE-2021-20191", + "summary": "Insertion of Sensitive Information into Log File in ansible", + "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.9.0, < 2.9.18", + "first_patched_version": { + "identifier": "2.9.18" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.10.0, < 2.10.7", + "first_patched_version": { + "identifier": "2.10.7" + } + } + ], + "severity": "medium", + "cvss": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, + "cwes": [ + { + "cwe_id": "CWE-532", + "name": "Insertion of Sensitive Information into Log File" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-8f4m-hccc-8qph" + }, + { + "type": "CVE", + "value": "CVE-2021-20191" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" + }, + { + "url": "https://access.redhat.com/security/cve/cve-2021-20191" + }, + { + "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" + } + ], + "published_at": "2021-06-01T17:38:00Z", + "updated_at": "2021-08-12T23:06:00Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + "url": "https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1", + "html_url": "https://github.com/octo-org/hello-world/security/dependabot/1", + "created_at": "2022-06-14T15:21:52Z", + "updated_at": "2022-06-14T15:21:52Z", + "dismissed_at": null, + "dismissed_by": null, + "dismissed_reason": null, + "dismissed_comment": null, + "fixed_at": null, + "assignees": [], + "repository": { + "id": 664700648, + "node_id": "MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=", + "name": "hello-world", + "full_name": "octo-org/hello-world", + "owner": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "private": true, + "html_url": "https://github.com/octo-org/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/hello-world", + "archive_url": "https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/hello-world/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/hello-world/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/hello-world/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/hello-world/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/hello-world/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/hello-world/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/hello-world/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/hello-world/downloads", + "events_url": "https://api.github.com/repos/octo-org/hello-world/events", + "forks_url": "https://api.github.com/repos/octo-org/hello-world/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/hello-world/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/hello-world/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/hello-world/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/hello-world/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/hello-world/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/hello-world/languages", + "merges_url": "https://api.github.com/repos/octo-org/hello-world/merges", + "milestones_url": "https://api.github.com/repos/octo-org/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/hello-world/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/hello-world/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/hello-world/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/hello-world/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/hello-world/subscription", + "tags_url": "https://api.github.com/repos/octo-org/hello-world/tags", + "teams_url": "https://api.github.com/repos/octo-org/hello-world/teams", + "trees_url": "https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}" + } + } + ] + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "alerts" + } + } + }, + "/orgs/{org}/dependabot/repository-access": { + "get": { + "summary": "Lists the repositories Dependabot can access in an organization", + "description": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/repository-access-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "in": "query", + "description": "The page number of results to fetch.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "default": 1 + } + }, + { + "name": "per_page", + "in": "query", + "description": "Number of results per page.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", + "type": "object", + "properties": { + "default_level": { + "type": [ + "string", + "null" + ], + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal", + null + ], + "examples": [ + "internal" + ] + }, + "accessible_repositories": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } + ] + } + } + }, + "additionalProperties": false + }, + "examples": { + "default": { + "value": { + "default_level": "public", + "accessible_repositories": [ + { + "id": 123456, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", + "name": "example-repo", + "full_name": "octocat/example-repo", + "owner": { + "name": "octocat", + "email": "octo@github.com", + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", + "gravatar_id": 1, + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat/example-repo", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "starred_at": "\"2020-07-09T00:17:55Z\"", + "user_view_type": "default" + }, + "private": false, + "html_url": "https://github.com/octocat/example-repo", + "description": "This is an example repository.", + "fork": false, + "url": "https://api.github.com/repos/octocat/example-repo", + "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", + "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", + "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", + "events_url": "https://api.github.com/repos/octocat/example-repo/events", + "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", + "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", + "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", + "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", + "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", + "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", + "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + } + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" + } + }, + "patch": { + "summary": "Updates Dependabot's repository access list for an organization", + "description": "Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.\n\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/update-repository-access-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repository_ids_to_add": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to add." + }, + "repository_ids_to_remove": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to remove." + } + }, + "example": { + "repository_ids_to_add": [ + 123, + 456 + ], + "repository_ids_to_remove": [ + 789 + ] + } + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status." + }, + "add-example": { + "summary": "Add repositories", + "value": { + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, + "/orgs/{org}/dependabot/repository-access/default-level": { + "put": { + "summary": "Set the default repository access level for Dependabot", + "description": "Sets the default level of repository access Dependabot will have while performing an update. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.\n\nThis operation supports both server-to-server and user-to-server access.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/set-repository-access-default-level", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "examples": [ + "internal" + ] + } + }, + "required": [ + "default_level" + ] + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status.", + "value": { + "default_level": "public" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, + "/orgs/{org}/dependabot/secrets": { + "get": { + "summary": "List organization secrets", + "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/list-org-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#list-organization-secrets" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "title": "Dependabot Secret for an Organization", + "description": "Secrets for GitHub Dependabot for an organization.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" + ] + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 3, + "secrets": [ + { + "name": "MY_ARTIFACTORY_PASSWORD", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "private" + }, + { + "name": "NPM_TOKEN", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "GH_TOKEN", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/dependabot/secrets/public-key": { + "get": { + "summary": "Get an organization public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "DependabotPublicKey", + "description": "The public key used for setting Dependabot Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "examples": [ + "1234567" + ] + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "examples": [ + "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + ] + } + }, + "required": [ + "key_id", + "key" + ] + }, + "examples": { + "default": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/dependabot/secrets/{secret_name}": { + "get": { + "summary": "Get an organization secret", + "description": "Gets a single organization secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/get-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Dependabot Secret for an Organization", + "description": "Secrets for GitHub Dependabot for an organization.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" + ] + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "NPM_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/create-or-update-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + }, + "visibility": { + "type": "string", + "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + }, + "required": [ + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Delete an organization secret", + "description": "Deletes a secret in an organization using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/delete-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { + "get": { + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/list-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "has_pull_requests": { + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + }, + "mode": { + "type": "string", + "description": "The bypass mode for the reviewer", + "enum": [ + "ALWAYS", + "EXEMPT" + ], + "default": "ALWAYS" + } + } + } + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Set selected repositories for an organization secret", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/set-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization secret", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/add-selected-repo-to-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "No Content when repository was added to the selected list" + }, + "409": { + "description": "Conflict when visibility type is not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Remove selected repository from an organization secret", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/remove-selected-repo-from-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response when repository was removed from the selected list" + }, + "409": { + "description": "Conflict when visibility type not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/docker/conflicts": { + "get": { + "summary": "Get list of conflicting packages during Docker migration for organization", + "description": "Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", + "tags": [ + "packages" + ], + "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Package", + "description": "A software package", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the package.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the package.", + "type": "string", + "examples": [ + "super-linter" + ] + }, + "package_type": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ], + "examples": [ + "docker" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/packages/container/super-linter" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "https://github.com/orgs/github/packages/container/package/super-linter" + ] + }, + "version_count": { + "description": "The number of versions of the package.", + "type": "integer", + "examples": [ + 1 + ] + }, + "visibility": { + "type": "string", + "enum": [ + "private", + "public" + ], + "examples": [ + "private" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "repository": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "has_pull_requests": { + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + }, + "mode": { + "type": "string", + "description": "The bypass mode for the reviewer", + "enum": [ + "ALWAYS", + "EXEMPT" + ], + "default": "ALWAYS" + } + } + } + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "name", + "package_type", + "visibility", + "url", + "html_url", + "version_count", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 197, + "name": "hello_docker", + "package_type": "container", + "owner": { + "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 + }, + "version_count": 1, + "visibility": "private", + "url": "https://api.github.com/orgs/github/packages/container/hello_docker", + "created_at": "2020-05-19T22:19:11Z", + "updated_at": "2020-05-19T22:19:11Z", + "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" + }, + { + "id": 198, + "name": "goodbye_docker", + "package_type": "container", + "owner": { + "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 + }, + "version_count": 2, + "visibility": "private", + "url": "https://api.github.com/orgs/github/packages/container/goodbye_docker", + "created_at": "2020-05-20T22:19:11Z", + "updated_at": "2020-05-20T22:19:11Z", + "html_url": "https://github.com/orgs/github/packages/container/package/goodbye_docker" + } + ] + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/orgs/{org}/events": { + "get": { + "summary": "List public organization events", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", + "tags": [ + "activity" + ], + "operationId": "activity/list-public-org-events", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/events#list-public-organization-events" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Event", + "description": "Event", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": [ + "string", + "null" + ] + }, + "actor": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "name", + "url" + ] + }, + "org": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] + }, + "payload": { + "oneOf": [ + { + "title": "CreateEvent", + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "ref_type": { + "type": "string" + }, + "full_ref": { + "type": "string" + }, + "master_branch": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "pusher_type": { + "type": "string" + } + }, + "required": [ + "ref", + "ref_type", + "full_ref", + "master_branch", + "pusher_type" + ] + }, + { + "title": "DeleteEvent", + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "ref_type": { + "type": "string" + }, + "full_ref": { + "type": "string" + }, + "pusher_type": { + "type": "string" + } + }, + "required": [ + "ref", + "ref_type", + "full_ref", + "pusher_type" + ] + }, + { + "title": "DiscussionEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "discussion": { + "title": "Discussion", + "description": "A Discussion in a repository.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "answer_html_url": { + "type": [ + "string", + "null" + ] + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "type": "string" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "description": "The current state of the discussion.\n`converting` means that the discussion is being converted from an issue.\n`transferring` means that the discussion is being transferred from another repository.", + "enum": [ + "open", + "closed", + "locked", + "converting", + "transferring" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "outdated", + "duplicate", + "reopened", + null + ], + "examples": [ + "resolved" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "examples": [ + 208045946 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDU6TGFiZWwyMDgwNDU5NDY=" + ] + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/labels/bug" + ] + }, + "name": { + "description": "The name of the label.", + "type": "string", + "examples": [ + "bug" + ] + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": [ + "string", + "null" + ], + "examples": [ + "Something isn't working" + ] + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string", + "examples": [ + "FFFFFF" + ] + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "state_reason", + "locked", + "comments", + "created_at", + "updated_at", + "active_lock_reason", + "body" + ] + } + }, + "required": [ + "action", + "discussion" + ] + }, + { + "title": "IssuesEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -155259,7 +162027,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -156414,7 +163182,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -268675,6 +275443,14 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether the repository has opted in to the immutable OIDC subject claim format. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim. If not set at the repository level, falls back to the organization-level setting.", + "type": "boolean" + }, + "sub_claim_prefix": { + "description": "The current `sub` claim prefix for this repository.", + "type": "string" } }, "required": [ @@ -268850,6 +275626,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for this repository. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim.", + "type": "boolean" } } }, @@ -426555,7 +433335,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -628277,6 +635057,18 @@ "string", "null" ] + }, + "validity": { + "type": [ + "string", + "null" + ], + "enum": [ + "active", + "inactive", + null + ], + "description": "Sets the validity of the secret scanning alert. Can be `active`, `inactive`, or `null` to clear the override." } }, "anyOf": [ @@ -629873,7 +636665,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" + "description": "State does not match the resolution or resolution comment, assignee does not have write access to the repository, or the requested validity change could not be applied to this alert" }, "503": { "description": "Service unavailable", @@ -707604,7 +714396,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -741394,2110 +748186,6591 @@ } } }, - "secret_scanning_delegated_alert_dismissal": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" + "secret_scanning_delegated_alert_dismissal": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + }, + "mode": { + "type": "string", + "description": "The bypass mode for the reviewer", + "enum": [ + "ALWAYS", + "EXEMPT" + ], + "default": "ALWAYS" + } + } + } + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + }, + "secret_scanning_delegated_alert_dismissal": { + "status": "disabled" + } + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "watching" + } + } + }, + "/user/teams": { + "get": { + "summary": "List teams for the authenticated user", + "description": "List all of the teams across all of the organizations to which the authenticated\nuser belongs.\n\nOAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint.\n\nWhen using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.", + "tags": [ + "teams" + ], + "operationId": "teams/list-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#list-teams-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Developers" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "push" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ] + } + ] + }, + "members_count": { + "type": "integer", + "examples": [ + 3 + ] + }, + "repos_count": { + "type": "integer", + "examples": [ + 10 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-14T16:53:42Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-08-17T12:37:15Z" + ] + }, + "organization": { + "title": "Team Organization", + "description": "Team Organization", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "examples": [ + "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type", + "created_at", + "updated_at", + "members_count", + "repos_count", + "organization" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "teams", + "subcategory": "teams" + } + } + }, + "/user/{account_id}": { + "get": { + "summary": "Get a user using their ID", + "description": "Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).", + "tags": [ + "users" + ], + "operationId": "users/get-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/users#get-a-user-using-their-id" + }, + "parameters": [ + { + "name": "account_id", + "description": "account_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "user_view_type": { + "type": "string" + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "user_view_type": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + } + ] + }, + "examples": { + "default-response": { + "summary": "Default response", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "response-with-git-hub-plan-information": { + "summary": "Response with GitHub plan information", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "plan": { + "name": "pro", + "space": 976562499, + "collaborators": 0, + "private_repos": 9999 + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" + } + } + }, + "/user/{user_id}/projectsV2/{project_number}/drafts": { + "post": { + "summary": "Create draft item for user owned project", + "description": "Create draft issue item for the specified user owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/create-draft-item-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project" + }, + "parameters": [ + { + "name": "user_id", + "description": "The unique identifier of the user.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_number", + "description": "The project's number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "description": "Details of the draft item to create in the project.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the draft issue item to create in the project." + }, + "body": { + "type": "string", + "description": "The body content of the draft issue item to create in the project." + } + }, + "required": [ + "title" + ] + }, + "examples": { + "title": { + "summary": "Example with Sample Draft Issue Title", + "value": { + "title": "Sample Draft Issue Title" + } + }, + "body": { + "summary": "Example with Sample Draft Issue Title and Body", + "value": { + "title": "Sample Draft Issue Title", + "body": "This is the body content of the draft issue." + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project item." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project item." + }, + "content": { + "oneOf": [ + { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } ] - } - } - }, - "secret_scanning_delegated_bypass": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } - } - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ], + "examples": [ + "all" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" ], "properties": { - "reviewer_id": { + "id": { + "description": "Unique identifier of the GitHub app", "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" + "examples": [ + 37 + ] }, - "reviewer_type": { + "slug": { + "description": "The slug name of the GitHub app", "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" + "examples": [ + "probot-owners" ] }, - "mode": { + "node_id": { "type": "string", - "description": "The bypass mode for the reviewer", - "enum": [ - "ALWAYS", - "EXEMPT" - ], - "default": "ALWAYS" - } - } - } - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - }, - "secret_scanning_delegated_alert_dismissal": { - "status": "disabled" - } - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "activity", - "subcategory": "watching" - } - } - }, - "/user/teams": { - "get": { - "summary": "List teams for the authenticated user", - "description": "List all of the teams across all of the organizations to which the authenticated\nuser belongs.\n\nOAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint.\n\nWhen using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.", - "tags": [ - "teams" - ], - "operationId": "teams/list-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-teams-for-the-authenticated-user" - }, - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "examples": [ - "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "teams", - "subcategory": "teams" - } - } - }, - "/user/{account_id}": { - "get": { - "summary": "Get a user using their ID", - "description": "Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).", - "tags": [ - "users" - ], - "operationId": "users/get-by-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/users/users#get-a-user-using-their-id" - }, - "parameters": [ - { - "name": "account_id", - "description": "account_id parameter", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "title": "Private User", - "description": "Private User", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ], - "examples": [ - "monalisa octocat" - ] - }, - "company": { - "type": [ - "string", - "null" - ], - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": [ - "string", - "null" - ], - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ], - "examples": [ - "There once was..." - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "monalisa" - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "private_gists": { - "type": "integer", - "examples": [ - 81 - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "disk_usage": { - "type": "integer", - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": "integer", - "examples": [ - 8 - ] - }, - "two_factor_authentication": { - "type": "boolean", - "examples": [ - true - ] - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] }, - "name": { - "type": "string" + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] }, - "space": { - "type": "integer" + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "business_plus": { - "type": "boolean" - }, - "ldap_dn": { - "type": "string" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at", - "collaborators", - "disk_usage", - "owned_private_repos", - "private_gists", - "total_private_repos", - "two_factor_authentication" - ] - }, - { - "title": "Public User", - "description": "Public User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] }, - "name": { - "type": "string" + "parent_issue_url": { + "description": "URL to get the parent issue of this issue, if it is a sub-issue", + "type": [ + "string", + "null" + ], + "format": "uri" }, - "space": { - "type": "integer" + "pinned_comment": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/comments/1" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string", + "examples": [ + "What version of Safari were you using when you observed this bug?" + ] + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "pinned_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "pinned_at", + "pinned_by" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ] + } + ] }, - "private_repos": { - "type": "integer" + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "examples": [ + "Sample text" + ] + }, + { + "type": "number", + "examples": [ + 42.5 + ] + }, + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the option", + "type": "string", + "examples": [ + "High" + ] + }, + "color": { + "description": "The color of the option", + "type": "string", + "examples": [ + "red" + ] + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } } }, "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "private_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "disk_usage": { - "type": "integer", - "examples": [ - 1 + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "created_at", + "updated_at" ] }, - "collaborators": { - "type": "integer", - "examples": [ - 3 - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false - } - ] - }, - "examples": { - "default-response": { - "summary": "Default response", - "value": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z" - } - }, - "response-with-git-hub-plan-information": { - "summary": "Response with GitHub plan information", - "value": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z", - "plan": { - "name": "pro", - "space": 976562499, - "collaborators": 0, - "private_repos": 9999 - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "users" - } - } - }, - "/user/{user_id}/projectsV2/{project_number}/drafts": { - "post": { - "summary": "Create draft item for user owned project", - "description": "Create draft issue item for the specified user owned project.", - "tags": [ - "projects" - ], - "operationId": "projects/create-draft-item-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project" - }, - "parameters": [ - { - "name": "user_id", - "description": "The unique identifier of the user.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_number", - "description": "The project's number.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "description": "Details of the draft item to create in the project.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "The title of the draft issue item to create in the project." - }, - "body": { - "type": "string", - "description": "The body content of the draft issue item to create in the project." - } - }, - "required": [ - "title" - ] - }, - "examples": { - "title": { - "summary": "Example with Sample Draft Issue Title", - "value": { - "title": "Sample Draft Issue Title" - } - }, - "body": { - "summary": "Example with Sample Draft Issue Title and Body", - "value": { - "title": "Sample Draft Issue Title", - "body": "This is the body content of the draft issue." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Projects v2 Item", - "description": "An item belonging to a project", - "type": "object", - "properties": { - "id": { - "type": "number", - "description": "The unique identifier of the project item." - }, - "node_id": { - "type": "string", - "description": "The node ID of the project item." - }, - "content": { - "oneOf": [ { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "title": "Pull Request Simple", + "description": "Pull Request Simple", "type": "object", "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/1347" + ] + }, "id": { "type": "integer", - "format": "int64" + "format": "int64", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" + "type": "string", + "examples": [ + "MDExOlB1bGxSZXF1ZXN0MQ==" + ] }, - "url": { - "description": "URL for the issue", + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repositories/42/issues/1" + "https://github.com/octocat/Hello-World/pull/1347" ] }, - "repository_url": { + "diff_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/pull/1347.diff" + ] }, - "labels_url": { - "type": "string" + "patch_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/pull/1347.patch" + ] }, - "comments_url": { + "issue_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] }, - "events_url": { + "commits_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" + ] }, - "html_url": { + "review_comments_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" + ] + }, + "review_comment_url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] }, "number": { - "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ - 42 + 1347 ] }, "state": { - "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, - "state_reason": { - "description": "The reason for the current state", + "locked": { + "type": "boolean", + "examples": [ + true + ] + }, + "title": { + "type": "string", + "examples": [ + "new-feature" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body": { "type": [ "string", "null" ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null + "examples": [ + "Please pull these awesome changes" + ] + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "active_lock_reason": { + "type": [ + "string", + "null" ], "examples": [ - "not_planned" + "too heated" ] }, - "title": { - "description": "Title of the issue", + "created_at": { "type": "string", + "format": "date-time", "examples": [ - "Widget creation fails in Safari on OS X 10.8" + "2011-01-26T19:01:12Z" ] }, - "body": { - "description": "Contents of the issue", + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "closed_at": { "type": [ "string", "null" ], + "format": "date-time", "examples": [ - "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + "2011-01-26T19:01:12Z" ] }, - "user": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "merge_commit_sha": { + "type": [ + "string", + "null" + ], + "examples": [ + "e5bd3914e2e596debea16f433f57875b5b90bcd6" + ] + }, + "assignee": { "anyOf": [ { "type": "null" @@ -743513,963 +754786,3240 @@ "null" ] }, - "email": { + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "requested_reviewers": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent", + "type" + ] + } + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { "type": [ "string", "null" ] }, - "login": { + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", "type": "string", "examples": [ - "octocat" + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ], + "examples": [ + "all" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" ] }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "label", + "ref", + "repo", + "sha", + "user" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { "id": { + "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "examples": [ - 1 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "avatar_url": { + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "https://github.com/octocat/Hello-World" ] }, - "gravatar_id": { + "description": { "type": [ "string", "null" ], "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "This your first repo!" ] }, + "fork": { + "type": "boolean" + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "html_url": { + "archive_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "followers_url": { + "assignees_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "following_url": { + "blobs_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "gists_url": { + "branches_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, - "starred_url": { + "collaborators_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, - "subscriptions_url": { + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "organizations_url": { + "deployments_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "repos_url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "received_events_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "type": { + "git_commits_url": { "type": "string", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "git_refs_url": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "user_view_type": { + "git_tags_url": { "type": "string", "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - }, - "examples": [ - "bug", - "registration" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "email": { - "type": [ - "string", - "null" + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" ] }, - "login": { + "issue_comment_url": { "type": "string", "examples": [ - "octocat" + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, - "id": { - "type": "integer", - "format": "int64", + "issue_events_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, - "node_id": { + "issues_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, - "avatar_url": { + "keys_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "labels_url": { + "type": "string", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, - "url": { + "languages_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "html_url": { + "merges_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "followers_url": { + "milestones_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, - "following_url": { + "notifications_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, - "gists_url": { + "pulls_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, - "starred_url": { + "releases_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, - "subscriptions_url": { + "ssh_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "git@github.com:octocat/Hello-World.git" ] }, - "organizations_url": { + "stargazers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "repos_url": { + "statuses_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "events_url": { + "subscribers_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "received_events_url": { + "subscription_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "type": { + "tags_url": { "type": "string", + "format": "uri", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/tags" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "teams_url": { "type": "string", + "format": "uri", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "http://api.github.com/repos/octocat/Hello-World/teams" ] }, - "user_view_type": { + "trees_url": { "type": "string", "examples": [ - "public" + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { + }, + "clone_url": { "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" + "git:git.example.com/octocat/Hello-World" ] }, - "html_url": { + "hooks_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" + "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, - "labels_url": { + "svn_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + "https://svn.github.com/octocat/Hello-World" ] }, - "id": { + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { "type": "integer", "examples": [ - 1002604 + 9 ] }, - "node_id": { + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", "type": "string", "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" + "master" ] }, - "number": { - "description": "The number of the milestone.", + "open_issues_count": { "type": "integer", "examples": [ - 42 + 0 ] }, - "state": { - "description": "The state of the milestone.", + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": [ - "open", - "closed" + "all", + "collaborators_only" ], - "default": "open", "examples": [ - "open" + "all" ] }, - "title": { - "description": "The title of the milestone.", - "type": "string", + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "v1.0" + "2011-01-26T19:06:43Z" ] }, - "description": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { "type": [ "string", "null" ], + "format": "date-time", "examples": [ - "Tracking milestone for version 1.0" + "2011-01-26T19:14:43Z" ] }, - "creator": { - "anyOf": [ - { - "type": "null" + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" ] } + }, + "required": [ + "label", + "ref", + "repo", + "sha", + "user" ] }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { + "_links": { "type": "object", "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "comments": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "commits": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "statuses": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "html": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "issue": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] } }, "required": [ - "diff_url", - "html_url", - "patch_url", - "url" + "comments", + "commits", + "statuses", + "html", + "issue", + "review_comments", + "review_comment", + "self" ] }, - "closed_at": { + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "auto_merge": { + "title": "Auto merge", + "description": "The status of auto merging a pull request.", "type": [ - "string", + "object", "null" ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { + "properties": { + "enabled_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -744636,209 +758186,104 @@ "type", "url" ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { + "merge_method": { "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", + "description": "The merge method to use.", "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null + "merge", + "squash", + "rebase" ] }, - "created_at": { + "commit_title": { "type": "string", - "description": "The time the issue type created.", - "format": "date-time" + "description": "Title for the merge commit message." }, - "updated_at": { + "commit_message": { "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." + "description": "Commit message for the merge commit." } }, "required": [ - "id", - "node_id", - "name", - "description" + "enabled_by", + "merge_method", + "commit_title", + "commit_message" ] }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean", + "examples": [ + false + ] + } + }, + "required": [ + "_links", + "assignee", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merge_commit_sha", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge" + ] + }, + { + "title": "Draft Issue", + "description": "A draft issue in a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The ID of the draft issue" + }, + "node_id": { + "type": "string", + "description": "The node ID of the draft issue" + }, + "title": { + "type": "string", + "description": "The title of the draft issue" + }, + "body": { + "type": [ + "string", + "null" + ], + "description": "The body content of the draft issue" + }, + "user": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -745005,3157 +758450,3230 @@ "type", "url" ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ], - "examples": [ - "all" - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" ] }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time the draft issue was created" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time the draft issue was last updated" + } + }, + "required": [ + "id", + "node_id", + "title", + "user", + "created_at", + "updated_at" + ] + } + ], + "description": "The content represented by the item." + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the item was archived.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "description": "The URL of the project this item belongs to." + }, + "item_url": { + "type": "string", + "format": "uri", + "description": "The URL of the item in the project." + } + }, + "required": [ + "id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "examples": { + "draft_issue": { + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "drafts" + } + } + }, + "/users": { + "get": { + "summary": "List users", + "description": "Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.", + "tags": [ + "users" + ], + "operationId": "users/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/users#list-users" + }, + "parameters": [ + { + "name": "since", + "description": "A user ID. Only return users with an ID greater than this ID.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "description": "Not modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" + } + } + }, + "/users/{user_id}/projectsV2/{project_number}/views": { + "post": { + "summary": "Create a view for a user-owned project", + "description": "Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered.", + "tags": [ + "projects" + ], + "operationId": "projects/create-view-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project" + }, + "parameters": [ + { + "name": "user_id", + "description": "The unique identifier of the user.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_number", + "description": "The project's number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the view.", + "examples": [ + "Sprint Board" + ] + }, + "layout": { + "type": "string", + "description": "The layout of the view.", + "enum": [ + "table", + "board", + "roadmap" + ], + "examples": [ + "board" + ] + }, + "filter": { + "type": "string", + "description": "The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", + "examples": [ + "is:issue is:open" + ] + }, + "visible_fields": { + "type": "array", + "description": "`visible_fields` is not applicable to `roadmap` layout views.\nFor `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used.", + "items": { + "type": "integer" + }, + "examples": [ + 123, + 456, + 789 + ] + } + }, + "required": [ + "name", + "layout" + ], + "additionalProperties": false + }, + "examples": { + "table_view": { + "summary": "Create a table view", + "value": { + "name": "All Issues", + "layout": "table", + "filter": "is:issue", + "visible_fields": [ + 123, + 456, + 789 + ] + } + }, + "board_view": { + "summary": "Create a board view with filter", + "value": { + "name": "Sprint Board", + "layout": "board", + "filter": "is:issue is:open label:sprint", + "visible_fields": [ + 123, + 456, + 789 + ] + } + }, + "roadmap_view": { + "summary": "Create a roadmap view", + "value": { + "name": "Product Roadmap", + "layout": "roadmap" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response for creating a view in a user-owned project.", + "content": { + "application/json": { + "schema": { + "title": "Projects v2 View", + "description": "A view inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the view." + }, + "number": { + "type": "integer", + "description": "The number of the view within the project." + }, + "name": { + "type": "string", + "description": "The name of the view." + }, + "layout": { + "type": "string", + "description": "The layout of the view.", + "enum": [ + "table", + "board", + "roadmap" + ] + }, + "node_id": { + "type": "string", + "description": "The node ID of the view." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the view.", + "examples": [ + "https://api.github.com/orgs/octocat/projectsV2/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The web URL of the view.", + "examples": [ + "https://github.com/orgs/octocat/projects/1/views/1" + ] + }, + "creator": { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" ] }, - "author_association": { - "title": "author_association", + "login": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], "examples": [ - "OWNER" + "octocat" ] }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 ] }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" ] }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ "string", "null" ], - "format": "uri" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the issue comment", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/comments/1" - ] - }, - "body": { - "description": "Contents of the issue comment", - "type": "string", - "examples": [ - "What version of Safari were you using when you observed this bug?" - ] - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" ] }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" ] }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] - }, - { - "type": "number", - "examples": [ - 42.5 - ] - }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] - }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the view was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the view was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "filter": { + "type": [ + "string", + "null" + ], + "description": "The filter query for the view.", + "examples": [ + "is:issue is:open" + ] + }, + "visible_fields": { + "type": "array", + "description": "The list of field IDs that are visible in the view.", + "items": { + "type": "integer" + } + }, + "sort_by": { + "type": "array", + "description": "The sorting configuration for the view. Each element is a tuple of [field_id, direction] where direction is \"asc\" or \"desc\".", + "items": { + "type": "array", + "minItems": 2, + "maxItems": 2, + "items": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + }, + "group_by": { + "type": "array", + "description": "The list of field IDs used for horizontal grouping.", + "items": { + "type": "integer" + } + }, + "vertical_group_by": { + "type": "array", + "description": "The list of field IDs used for vertical grouping (board layout).", + "items": { + "type": "integer" + } + } + }, + "required": [ + "id", + "number", + "name", + "layout", + "node_id", + "project_url", + "html_url", + "creator", + "created_at", + "updated_at", + "visible_fields", + "sort_by", + "group_by", + "vertical_group_by" + ] + }, + "examples": { + "table_view": { + "summary": "Response for creating a table view", + "value": { + "value": { + "id": 1, + "number": 1, + "name": "Sprint Board", + "layout": "board", + "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", + "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", + "html_url": "https://github.com/orgs/octocat/projects/1/views/1", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "filter": "is:issue is:open", + "visible_fields": [ + 123, + 456, + 789 + ], + "sort_by": [ + [ + 123, + "asc" + ], + [ + 456, + "desc" + ] + ], + "group_by": [ + 123 + ], + "vertical_group_by": [ + 456 + ] + } + } + }, + "board_view": { + "summary": "Response for creating a board view with filter", + "value": { + "value": { + "id": 1, + "number": 1, + "name": "Sprint Board", + "layout": "board", + "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", + "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", + "html_url": "https://github.com/orgs/octocat/projects/1/views/1", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "filter": "is:issue is:open", + "visible_fields": [ + 123, + 456, + 789 + ], + "sort_by": [ + [ + 123, + "asc" + ], + [ + 456, + "desc" + ] + ], + "group_by": [ + 123 + ], + "vertical_group_by": [ + 456 + ] + } + } + }, + "roadmap_view": { + "summary": "Response for creating a roadmap view", + "value": { + "value": { + "id": 1, + "number": 1, + "name": "Sprint Board", + "layout": "board", + "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", + "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", + "html_url": "https://github.com/orgs/octocat/projects/1/views/1", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "filter": "is:issue is:open", + "visible_fields": [ + 123, + 456, + 789 + ], + "sort_by": [ + [ + 123, + "asc" + ], + [ + 456, + "desc" + ] + ], + "group_by": [ + 123 + ], + "vertical_group_by": [ + 456 + ] + } + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } } - } - }, - "required": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "created_at", - "updated_at" + ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "projects", + "subcategory": "views" + } + } + }, + "/users/{username}": { + "get": { + "summary": "Get a user", + "description": "Provides publicly available information about someone with a GitHub account.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).", + "tags": [ + "users" + ], + "operationId": "users/get-by-username", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/users#get-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "octocat" ] }, - { - "title": "Pull Request Simple", - "description": "Pull Request Simple", + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "user_view_type": { + "type": "string" + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/1347" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOlB1bGxSZXF1ZXN0MQ==" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/pull/1347" - ] - }, - "diff_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/pull/1347.diff" - ] - }, - "patch_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/pull/1347.patch" - ] - }, - "issue_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - }, - "commits_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" - ] - }, - "review_comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" - ] - }, - "review_comment_url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" - ] - }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" - ] + "collaborators": { + "type": "integer" }, - "statuses_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] + "name": { + "type": "string" }, - "number": { - "type": "integer", - "examples": [ - 1347 - ] + "space": { + "type": "integer" }, - "state": { - "type": "string", - "examples": [ - "open" - ] + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "user_view_type": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" }, - "locked": { - "type": "boolean", - "examples": [ - true - ] + "name": { + "type": "string" }, - "title": { - "type": "string", - "examples": [ - "new-feature" - ] + "space": { + "type": "integer" }, - "user": { - "anyOf": [ - { - "type": "null" + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + } + ] + }, + "examples": { + "default-response": { + "summary": "Default response", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "response-with-git-hub-plan-information": { + "summary": "Response with GitHub plan information", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "plan": { + "name": "pro", + "space": 976562499, + "collaborators": 0, + "private_repos": 9999 + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" + } + } + }, + "/users/{username}/attestations/bulk-list": { + "post": { + "summary": "List attestations by bulk subject digests", + "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "users" + ], + "operationId": "users/list-attestations-bulk", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "subject_digests": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of subject digests to fetch attestations for.", + "minItems": 1, + "maxItems": 1024 + }, + "predicate_type": { + "type": "string", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types." + } + }, + "required": [ + "subject_digests" + ] + }, + "examples": { + "default": { + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ] + } + }, + "withPredicateType": { + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ], + "predicateType": "provenance" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations_subject_digests": { + "type": "object", + "additionalProperties": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" }, - { - "title": "Simple User", - "description": "A GitHub user.", + "verificationMaterial": { "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true } - ] + }, + "description": "The bundle of the attestation." }, - "body": { - "type": [ - "string", - "null" - ], - "examples": [ - "Please pull these awesome changes" - ] + "repository_id": { + "type": "integer" }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" + "bundle_url": { + "type": "string" + } + } + } + }, + "description": "Mapping of subject digest to bundles." + }, + "page_info": { + "type": "object", + "properties": { + "has_next": { + "type": "boolean", + "description": "Indicates whether there is a next page." + }, + "has_previous": { + "type": "boolean", + "description": "Indicates whether there is a previous page." + }, + "next": { + "type": "string", + "description": "The cursor to the next page." + }, + "previous": { + "type": "string", + "description": "The cursor to the previous page." + } + }, + "description": "Information about the current page." + } + } + }, + "examples": { + "default": { + "value": { + "attestations_subject_digests": [ + { + "sha256:abc": [ + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" } }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + } + ] + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + } + } + }, + "/users/{username}/attestations/delete-request": { + "post": { + "summary": "Delete attestations in bulk", + "description": "Delete artifact attestations in bulk by either subject digests or unique ID.", + "tags": [ + "users" + ], + "operationId": "users/delete-attestations-bulk", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "oneOf": [ + { + "properties": { + "subject_digests": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of subject digests associated with the artifact attestations to delete.", + "minItems": 1, + "maxItems": 1024 + } + }, + "required": [ + "subject_digests" + ] + }, + { + "properties": { + "attestation_ids": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of unique IDs associated with the artifact attestations to delete.", + "minItems": 1, + "maxItems": 1024 + } + }, + "required": [ + "attestation_ids" + ] + } + ], + "description": "The request body must include either `subject_digests` or `attestation_ids`, but not both." + }, + "examples": { + "by-subject-digests": { + "summary": "Delete by subject digests", + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ] + } + }, + "by-attestation-ids": { + "summary": "Delete by attestation IDs", + "value": { + "attestation_ids": [ + 111, + 222 + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + } + } + }, + "/users/{username}/attestations/digest/{subject_digest}": { + "delete": { + "summary": "Delete attestations by subject digest", + "description": "Delete an artifact attestation by subject digest.", + "tags": [ + "users" + ], + "operationId": "users/delete-attestations-by-subject-digest", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "subject_digest", + "description": "Subject Digest", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "responses": { + "200": { + "description": "Response" + }, + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + } + } + }, + "/users/{username}/attestations/{attestation_id}": { + "delete": { + "summary": "Delete attestations by ID", + "description": "Delete an artifact attestation by unique ID that is associated with a repository owned by a user.", + "tags": [ + "users" + ], + "operationId": "users/delete-attestations-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/attestations#delete-attestations-by-id" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "attestation_id", + "description": "Attestation ID", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response" + }, + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + } + } + }, + "/users/{username}/attestations/{subject_digest}": { + "get": { + "summary": "List attestations", + "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "users" + ], + "operationId": "users/list-attestations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/attestations#list-attestations" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "subject_digest", + "description": "Subject Digest", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." + }, + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + }, + "initiator": { + "type": "string" + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "attestations": [ + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" } }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ] + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "examples": [ - "too heated" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "merge_commit_sha": { - "type": [ - "string", - "null" ], - "examples": [ - "e5bd3914e2e596debea16f433f57875b5b90bcd6" - ] + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } }, - "assignee": { - "anyOf": [ + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ { - "type": "null" - }, + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + }, + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" } }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" } - ] + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } }, - "assignees": { - "type": "array", - "items": { + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + } + ] + } + } + } + } + } + }, + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + } + } + }, + "/users/{username}/copilot-spaces": { + "get": { + "summary": "List Copilot Spaces for a user", + "description": "Lists Copilot Spaces owned by a user. The authenticated user must have read access to the user's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes the user's own spaces, and public user spaces when accessing another user's spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-copilot-spaces-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "spaces" + ], + "properties": { + "spaces": { + "type": "array", + "description": "The list of Copilot Spaces on this page of results.", + "items": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { + "anyOf": [ + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -748322,36 +761840,20 @@ "type", "url" ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, "login": { "type": "string", "examples": [ - "octocat" + "github" ] }, "id": { "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -748359,3340 +761861,2875 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/orgs/github/repos" ] }, "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "https://api.github.com/orgs/github/events" ] }, - "user_view_type": { + "hooks_url": { "type": "string", "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" + "https://api.github.com/orgs/github/hooks" ] }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { + "issues_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/orgs/rails/teams/core" + "https://api.github.com/orgs/github/issues" ] }, "members_url": { - "type": "string" - }, - "repositories_url": { "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - 42 - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } + "https://api.github.com/orgs/github/members{/member}" ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ], - "examples": [ - "all" - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "sha": { - "type": "string" + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - } + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "base": { + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { "type": "object", "properties": { - "label": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." }, - "ref": { - "type": "string" + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { "type": "object", + "description": "Metadata specific to the resource type.", "properties": { - "id": { - "description": "Unique identifier of the repository", + "repository_id": { "type": "integer", - "format": "int64", - "examples": [ - 42 - ] + "description": "Repository ID for repository or file resources." }, - "node_id": { + "file_path": { "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "description": "File path for file resources." }, - "name": { - "description": "The name of the repository.", + "text": { "type": "string", - "examples": [ - "Team Environment" - ] + "description": "Text content for free text resources." }, - "full_name": { + "name": { "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "description": "Name for the resource." }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "number": { + "type": "integer", + "description": "Issue or PR number." }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." }, - "html_url": { + "media_type": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" + "description": "Media type for media content resources." }, "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] + "description": "URL for media content resources." }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "height": { "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] + "description": "Height for media content resources." }, - "open_issues_count": { + "width": { "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ], - "examples": [ - "all" - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } + "description": "Width for media content resources." } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "sha": { + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + }, + "examples": { + "default": { + "summary": "Example response for listing user copilot spaces", + "value": { + "spaces": [ + { + "id": 42, + "number": 1, + "name": "Personal Research Space", + "description": "My personal space for research and development", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/1", + "api_url": "https://api.github.com/user/1/copilot-spaces/1" + }, + { + "id": 43, + "number": 2, + "name": "Learning Space", + "description": "Space for learning new technologies", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-17T08:20:00Z", + "updated_at": "2023-02-17T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/2", + "api_url": "https://api.github.com/user/1/copilot-spaces/2" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "post": { + "summary": "Create a Copilot Space for a user", + "description": "Creates a new Copilot Space owned by a user. Only the authenticated user can create spaces for their own account.\n\nUsers can create personal Copilot Spaces for their individual use.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/create-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Personal space for development assistance" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help me with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "no_access" + ], + "description": "The base role that determines default permissions for the space.\n- `no_access`: No default access (default)\n- `reader`: Makes the space publicly readable\nNote: User spaces do not support writer or admin base roles.", + "default": "no_access" + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "My Development Space", + "description": "Personal space for development assistance", + "general_instructions": "Help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/App.js" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Development Notes", + "text": "Focus on clean code principles and modern React patterns" + } + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + }, + "examples": { + "default": { + "summary": "Example response for a user copilot space", + "value": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}": { + "get": { + "summary": "Get a Copilot Space for a user", + "description": "Gets details about a specific Copilot Space owned by a user. The authenticated user must have read access to the Space.\n\nPrivate user spaces require the authenticated user to be the owner of the space.\nPublic user spaces are accessible to any authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/get-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" + "email": { + "type": [ + "string", + "null" ] }, - "author_association": { - "title": "author_association", + "login": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], "examples": [ - "OWNER" + "octocat" ] }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "object", + "string", "null" ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" ] }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean", + "url": { + "type": "string", + "format": "uri", "examples": [ - false + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", "html_url", "id", "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", "url", - "user", - "author_association", - "auto_merge" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + }, + "examples": { + "default": { + "summary": "Example response for a user copilot space", + "value": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } }, { - "title": "Draft Issue", - "description": "A draft issue in a project", + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "put": { + "summary": "Set a Copilot Space for a user", + "description": "Updates a Copilot Space owned by a user. Only the authenticated user can update spaces for their own account.\n\nUsers can update their personal Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "Updated Development Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Updated personal space for development assistance" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Updated instructions to help me with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "no_access" + ], + "description": "The base role that determines default permissions for the space. Changing this field requires admin permissions.\n- `no_access`: No default access (default)\n- `reader`: Makes the space publicly readable\nNote: User spaces do not support writer or admin base roles." + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "Updated Development Space", + "description": "Updated personal space for development assistance", + "general_instructions": "Updated instructions to help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/UpdatedApp.js" + } + }, + { + "id": 123, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Development Notes", + "text": "Updated focus on clean code principles and modern React patterns" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { - "type": "number", - "description": "The ID of the draft issue" + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] }, "node_id": { "type": "string", - "description": "The node ID of the draft issue" + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "title": { + "avatar_url": { "type": "string", - "description": "The title of the draft issue" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "body": { + "gravatar_id": { "type": [ "string", "null" ], - "description": "The body content of the draft issue" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" ] }, - "created_at": { + "repos_url": { "type": "string", - "format": "date-time", - "description": "The time the draft issue was created" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "updated_at": { + "events_url": { "type": "string", - "format": "date-time", - "description": "The time the draft issue was last updated" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "title", - "user", - "created_at", - "updated_at" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" ] } ], - "description": "The content represented by the item." - }, - "content_type": { - "title": "Projects v2 Item Content Type", - "description": "The type of content tracked in a project item", - "type": "string", - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] + "description": "The user or organization that owns this space." }, "creator": { "title": "Simple User", @@ -751865,83 +764902,170 @@ "created_at": { "type": "string", "format": "date-time", - "description": "The time when the item was created.", + "description": "The date and time the space was created.", "examples": [ - "2022-04-28T12:00:00Z" + "2023-01-01T00:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", - "description": "The time when the item was last updated.", + "description": "The date and time the space was last updated.", "examples": [ - "2022-04-28T12:00:00Z" + "2023-01-01T12:00:00Z" ] }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time when the item was archived.", + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", "examples": [ - "2022-04-28T12:00:00Z" + "https://github.com/copilot/spaces/octo-org/5" ] }, - "project_url": { + "api_url": { "type": "string", "format": "uri", - "description": "The URL of the project this item belongs to." + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] }, - "item_url": { - "type": "string", - "format": "uri", - "description": "The URL of the item in the project." + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } } }, "required": [ "id", - "content_type", + "number", + "name", + "base_role", + "owner", + "creator", "created_at", "updated_at", - "archived_at" - ] + "html_url", + "api_url" + ], + "additionalProperties": false }, "examples": { - "draft_issue": { + "default": { + "summary": "Example response for a user copilot space", "value": { - "id": 17, - "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", - "content": { - "id": 38, - "node_id": "I_kwDOANN5s85FtLts", - "title": "Example Draft Issue", - "body": "This is a draft issue in the project.", - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false }, - "content_type": "DraftIssue", "creator": { "login": "octocat", "id": 1, @@ -751962,20 +765086,35 @@ "type": "User", "site_admin": false }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "archived_at": null, - "project_url": "https://api.github.com/users/octocat/projectsV2/1", - "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] } } } } } }, - "304": { - "description": "Not modified" - }, "403": { "description": "Forbidden", "content": { @@ -752002,8 +765141,8 @@ } } }, - "401": { - "description": "Requires authentication", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -752027,45 +765166,262 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects", - "subcategory": "drafts" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "delete": { + "summary": "Delete a Copilot Space for a user", + "description": "Deletes a Copilot Space owned by a user. The authenticated user must be the owner of the space.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a space will remove all associated resources and configurations.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/delete-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "The Copilot Space has been successfully deleted." + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } } }, - "/users": { + "/users/{username}/copilot-spaces/{space_number}/collaborators": { "get": { - "summary": "List users", - "description": "Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.", + "summary": "List collaborators for a Copilot Space for a user", + "description": "Lists all collaborators for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nEach collaborator entry specifies which user has access to the space and at what level (reader, writer, or admin). The space owner is excluded from this list.\n\nTeam collaborators are not supported for user-owned Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/list", + "operationId": "copilot-spaces/list-collaborators-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/users/users#list-users" + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-a-copilot-space-for-a-user" }, "parameters": [ { - "name": "since", - "description": "A user ID. Only return users with an ID greater than this ID.", - "in": "query", - "required": false, + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "integer" } } ], @@ -752075,241 +765431,463 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" + "type": "object", + "required": [ + "collaborators" + ], + "properties": { + "collaborators": { + "type": "array", + "description": "The list of collaborators for this Copilot Space.", + "items": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } ] } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + } } }, "examples": { "default": { - "value": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ] + "value": { + "collaborators": [ + { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "User", + "role": "reader", + "login": "github-user", + "id": 67890, + "node_id": "MDQ6VXNlcjY3ODkw", + "avatar_url": "https://github.com/images/error/other_user.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github-user", + "html_url": "https://github.com/github-user", + "followers_url": "https://api.github.com/users/github-user/followers", + "following_url": "https://api.github.com/users/github-user/following{/other_user}", + "gists_url": "https://api.github.com/users/github-user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github-user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github-user/subscriptions", + "organizations_url": "https://api.github.com/users/github-user/orgs", + "repos_url": "https://api.github.com/users/github-user/repos", + "events_url": "https://api.github.com/users/github-user/events{/privacy}", + "received_events_url": "https://api.github.com/users/github-user/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "GitHub User", + "company": null, + "blog": "", + "location": null, + "email": null, + "hireable": null, + "bio": null, + "twitter_username": null, + "public_repos": 5, + "public_gists": 0, + "followers": 10, + "following": 5, + "created_at": "2010-01-14T04:33:35Z", + "updated_at": "2010-01-14T04:33:35Z" + } + ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\"", + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } } } } }, - "304": { - "description": "Not modified" + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "users" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" } - } - }, - "/users/{user_id}/projectsV2/{project_number}/views": { + }, "post": { - "summary": "Create a view for a user-owned project", - "description": "Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered.", + "summary": "Add a collaborator to a Copilot Space for a user", + "description": "Adds a collaborator to a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nTeam collaborators are not supported for user-owned Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", "tags": [ - "projects" + "copilot-spaces" ], - "operationId": "projects/create-view-for-user", + "operationId": "copilot-spaces/add-collaborator-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project" + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-a-copilot-space-for-a-user" }, "parameters": [ { - "name": "user_id", - "description": "The unique identifier of the user.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { @@ -752317,8 +765895,8 @@ } }, { - "name": "project_number", - "description": "The project's number.", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { @@ -752332,84 +765910,41 @@ "application/json": { "schema": { "type": "object", + "required": [ + "actor_type", + "actor_identifier", + "role" + ], "properties": { - "name": { - "type": "string", - "description": "The name of the view.", - "examples": [ - "Sprint Board" - ] - }, - "layout": { + "actor_type": { "type": "string", - "description": "The layout of the view.", "enum": [ - "table", - "board", - "roadmap" + "User", + "Team" ], - "examples": [ - "board" - ] + "description": "The type of actor (must be `User` for user-owned spaces; `Team` will be rejected)." }, - "filter": { + "actor_identifier": { "type": "string", - "description": "The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", - "examples": [ - "is:issue is:open" - ] + "description": "The username of the collaborator. The numeric user ID is also accepted." }, - "visible_fields": { - "type": "array", - "description": "`visible_fields` is not applicable to `roadmap` layout views.\nFor `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used.", - "items": { - "type": "integer" - }, - "examples": [ - 123, - 456, - 789 - ] + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role to grant to the collaborator." } - }, - "required": [ - "name", - "layout" - ], - "additionalProperties": false + } }, "examples": { - "table_view": { - "summary": "Create a table view", - "value": { - "name": "All Issues", - "layout": "table", - "filter": "is:issue", - "visible_fields": [ - 123, - 456, - 789 - ] - } - }, - "board_view": { - "summary": "Create a board view with filter", - "value": { - "name": "Sprint Board", - "layout": "board", - "filter": "is:issue is:open label:sprint", - "visible_fields": [ - 123, - 456, - 789 - ] - } - }, - "roadmap_view": { - "summary": "Create a roadmap view", + "default": { "value": { - "name": "Product Roadmap", - "layout": "roadmap" + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" } } } @@ -752418,55 +765953,15 @@ }, "responses": { "201": { - "description": "Response for creating a view in a user-owned project.", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Projects v2 View", - "description": "A view inside a projects v2 project", + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the view." - }, - "number": { - "type": "integer", - "description": "The number of the view within the project." - }, - "name": { - "type": "string", - "description": "The name of the view." - }, - "layout": { - "type": "string", - "description": "The layout of the view.", - "enum": [ - "table", - "board", - "roadmap" - ] - }, - "node_id": { - "type": "string", - "description": "The node ID of the view." - }, - "project_url": { - "type": "string", - "description": "The API URL of the project that contains the view.", - "examples": [ - "https://api.github.com/orgs/octocat/projectsV2/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The web URL of the view.", - "examples": [ - "https://github.com/orgs/octocat/projects/1/views/1" - ] - }, - "creator": { + "anyOf": [ + { "allOf": [ { "title": "Simple User", @@ -752635,274 +766130,722 @@ "type", "url" ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] } ] }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The time when the view was created.", - "examples": [ - "2022-04-28T12:00:00Z" + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" ] + } + ] + }, + "examples": { + "default": { + "value": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The time when the view was last updated.", - "examples": [ - "2022-04-28T12:00:00Z" - ] + "documentation_url": { + "type": "string" }, - "filter": { - "type": [ - "string", - "null" - ], - "description": "The filter query for the view.", - "examples": [ - "is:issue is:open" - ] + "url": { + "type": "string" }, - "visible_fields": { - "type": "array", - "description": "The list of field IDs that are visible in the view.", - "items": { - "type": "integer" - } + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "sort_by": { + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", - "description": "The sorting configuration for the view. Each element is a tuple of [field_id, direction] where direction is \"asc\" or \"desc\".", "items": { - "type": "array", - "minItems": 2, - "maxItems": 2, - "items": { - "oneOf": [ - { - "type": "integer" + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { + "put": { + "summary": "Set a collaborator role for a Copilot Space for a user", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-collaborator-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "The type of actor (must be `User` for user-owned spaces; `Team` will be rejected).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username of the collaborator. The numeric user ID is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "role" + ], + "properties": { + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The new role to grant to the collaborator. Use `no_access` to remove the collaborator." + } + } + }, + "examples": { + "default": { + "value": { + "role": "admin" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - { - "type": "string" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" } + }, + "required": [ + "actor_type", + "role" ] } - } - }, - "group_by": { - "type": "array", - "description": "The list of field IDs used for horizontal grouping.", - "items": { - "type": "integer" - } + ] }, - "vertical_group_by": { - "type": "array", - "description": "The list of field IDs used for vertical grouping (board layout).", - "items": { - "type": "integer" - } - } - }, - "required": [ - "id", - "number", - "name", - "layout", - "node_id", - "project_url", - "html_url", - "creator", - "created_at", - "updated_at", - "visible_fields", - "sort_by", - "group_by", - "vertical_group_by" - ] - }, - "examples": { - "table_view": { - "summary": "Response for creating a table view", - "value": { - "value": { - "id": 1, - "number": 1, - "name": "Sprint Board", - "layout": "board", - "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", - "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", - "html_url": "https://github.com/orgs/octocat/projects/1/views/1", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "filter": "is:issue is:open", - "visible_fields": [ - 123, - 456, - 789 - ], - "sort_by": [ - [ - 123, - "asc" + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" ], - [ - 456, - "desc" + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" ] - ], - "group_by": [ - 123 - ], - "vertical_group_by": [ - 456 - ] - } - } - }, - "board_view": { - "summary": "Response for creating a board view with filter", - "value": { - "value": { - "id": 1, - "number": 1, - "name": "Sprint Board", - "layout": "board", - "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", - "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", - "html_url": "https://github.com/orgs/octocat/projects/1/views/1", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "filter": "is:issue is:open", - "visible_fields": [ - 123, - 456, - 789 - ], - "sort_by": [ - [ - 123, - "asc" - ], - [ - 456, - "desc" + "description": { + "type": [ + "string", + "null" ] - ], - "group_by": [ - 123 - ], - "vertical_group_by": [ - 456 - ] - } - } - }, - "roadmap_view": { - "summary": "Response for creating a roadmap view", - "value": { - "value": { - "id": 1, - "number": 1, - "name": "Sprint Board", - "layout": "board", - "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", - "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", - "html_url": "https://github.com/orgs/octocat/projects/1/views/1", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "filter": "is:issue is:open", - "visible_fields": [ - 123, - 456, - 789 - ], - "sort_by": [ - [ - 123, - "asc" - ], - [ - 456, - "desc" + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" ] - ], - "group_by": [ - 123 - ], - "vertical_group_by": [ - 456 - ] - } + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + }, + "examples": { + "default": { + "value": { + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" } } } } } }, - "304": { - "description": "Not modified" + "204": { + "description": "Response when `role` is `no_access` and the collaborator was removed." }, "403": { "description": "Forbidden", @@ -752930,32 +766873,6 @@ } } }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "404": { "description": "Resource not found", "content": { @@ -753056,9 +766973,99 @@ } } } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + }, + "delete": { + "summary": "Remove a collaborator from a Copilot Space for a user", + "description": "Removes a collaborator from a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/remove-collaborator-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "The type of actor (must be `User` for user-owned spaces; `Team` will be rejected).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username of the collaborator. The numeric user ID is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } }, - "503": { - "description": "Service unavailable", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -753085,24 +767092,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": false, - "category": "projects", - "subcategory": "views" + "category": "copilot-spaces", + "subcategory": "collaborators" } } }, - "/users/{username}": { + "/users/{username}/copilot-spaces/{space_number}/resources": { "get": { - "summary": "Get a user", - "description": "Provides publicly available information about someone with a GitHub account.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).", + "summary": "List resources for a Copilot Space for a user", + "description": "Lists all resources attached to a specific Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/get-by-username", + "operationId": "copilot-spaces/list-resources-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/users/users#get-a-user" + "url": "https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-a-copilot-space-for-a-user" }, "parameters": [ { @@ -753113,6 +767119,15 @@ "schema": { "type": "string" } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { @@ -753121,676 +767136,112 @@ "content": { "application/json": { "schema": { - "oneOf": [ - { - "title": "Private User", - "description": "Private User", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ], - "examples": [ - "monalisa octocat" - ] - }, - "company": { - "type": [ - "string", - "null" - ], - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": [ - "string", - "null" - ], - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ], - "examples": [ - "There once was..." - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "monalisa" - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "private_gists": { - "type": "integer", - "examples": [ - 81 - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "disk_usage": { - "type": "integer", - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": "integer", - "examples": [ - 8 - ] - }, - "two_factor_authentication": { - "type": "boolean", - "examples": [ - true - ] - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } + "type": "object", + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "business_plus": { - "type": "boolean" - }, - "ldap_dn": { - "type": "string" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at", - "collaborators", - "disk_usage", - "owned_private_repos", - "private_gists", - "total_private_repos", - "two_factor_authentication" - ] - }, - { - "title": "Public User", - "description": "Public User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "private_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "disk_usage": { - "type": "integer", - "examples": [ - 1 - ] + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } }, - "collaborators": { - "type": "integer", - "examples": [ - 3 - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } } - ] + } }, "examples": { - "default-response": { - "summary": "Default response", + "default": { "value": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z" + "resources": [ + { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + ] } - }, - "response-with-git-hub-plan-information": { - "summary": "Response with GitHub plan information", - "value": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z", - "plan": { - "name": "pro", - "space": 976562499, - "collaborators": 0, - "private_repos": 9999 - } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -753825,60 +767276,39 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "users" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/users/{username}/attestations/bulk-list": { + }, "post": { - "summary": "List attestations by bulk subject digests", - "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "summary": "Create a resource for a Copilot Space for a user", + "description": "Creates a new resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/list-attestations-bulk", + "operationId": "copilot-spaces/create-resource-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests" + "url": "https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-a-copilot-space-for-a-user" }, "parameters": [ { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, "schema": { "type": "string" } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -753888,41 +767318,55 @@ "application/json": { "schema": { "type": "object", + "required": [ + "resource_type", + "metadata" + ], "properties": { - "subject_digests": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of subject digests to fetch attestations for.", - "minItems": 1, - "maxItems": 1024 - }, - "predicate_type": { + "resource_type": { "type": "string", - "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types." + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ], + "description": "The type of resource to create." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata.", + "additionalProperties": true } - }, - "required": [ - "subject_digests" - ] + } }, "examples": { - "default": { + "free_text": { "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" - ] + "resource_type": "free_text", + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + } } }, - "withPredicateType": { + "repository": { "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" - ], - "predicateType": "provenance" + "resource_type": "repository", + "metadata": { + "repository_id": 42 + } + } + }, + "github_file": { + "value": { + "resource_type": "github_file", + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + } } } } @@ -753930,314 +767374,182 @@ } }, "responses": { - "200": { - "description": "Response", + "201": { + "description": "Resource created", "content": { "application/json": { "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", "type": "object", "properties": { - "attestations_subject_digests": { - "type": "object", - "additionalProperties": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "bundle": { - "type": "object", - "properties": { - "mediaType": { - "type": "string" - }, - "verificationMaterial": { - "type": "object", - "properties": {}, - "additionalProperties": true - }, - "dsseEnvelope": { - "type": "object", - "properties": {}, - "additionalProperties": true - } - }, - "description": "The bundle of the attestation." - }, - "repository_id": { - "type": "integer" - }, - "bundle_url": { - "type": "string" - } - } - } - }, - "description": "Mapping of subject digest to bundles." + "id": { + "type": "integer", + "description": "The unique identifier of the resource." }, - "page_info": { + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { "type": "object", - "properties": { - "has_next": { - "type": "boolean", - "description": "Indicates whether there is a next page." - }, - "has_previous": { - "type": "boolean", - "description": "Indicates whether there is a previous page." - }, - "next": { - "type": "string", - "description": "The cursor to the next page." - }, - "previous": { - "type": "string", - "description": "The cursor to the previous page." - } + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" }, - "description": "Information about the current page." + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" } } + } + } + } + }, + "200": { + "description": "Duplicate github_file resource already exists", + "content": { + "application/json": { + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] }, "examples": { "default": { "value": { - "attestations_subject_digests": [ - { - "sha256:abc": [ - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - }, - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - } - ] - } - ] + "id": 1, + "resource_type": "github_file", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "attestations" - } - } - }, - "/users/{username}/attestations/delete-request": { - "post": { - "summary": "Delete attestations in bulk", - "description": "Delete artifact attestations in bulk by either subject digests or unique ID.", - "tags": [ - "users" - ], - "operationId": "users/delete-attestations-bulk", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk" - }, - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "oneOf": [ - { - "properties": { - "subject_digests": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of subject digests associated with the artifact attestations to delete.", - "minItems": 1, - "maxItems": 1024 - } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "required": [ - "subject_digests" - ] - }, - { - "properties": { - "attestation_ids": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "List of unique IDs associated with the artifact attestations to delete.", - "minItems": 1, - "maxItems": 1024 - } + "documentation_url": { + "type": "string" }, - "required": [ - "attestation_ids" - ] - } - ], - "description": "The request body must include either `subject_digests` or `attestation_ids`, but not both." - }, - "examples": { - "by-subject-digests": { - "summary": "Delete by subject digests", - "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" - ] - } - }, - "by-attestation-ids": { - "summary": "Delete by attestation IDs", - "value": { - "attestation_ids": [ - 111, - 222 - ] + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } } } } - } - }, - "responses": { - "200": { - "description": "Response" }, "404": { "description": "Resource not found", @@ -754264,27 +767576,101 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "attestations" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" } } }, - "/users/{username}/attestations/digest/{subject_digest}": { - "delete": { - "summary": "Delete attestations by subject digest", - "description": "Delete an artifact attestation by subject digest.", + "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}": { + "get": { + "summary": "Get a resource for a Copilot Space for a user", + "description": "Gets a specific resource attached to a Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/delete-attestations-by-subject-digest", + "operationId": "copilot-spaces/get-resource-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest" + "url": "https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-a-copilot-space-for-a-user" }, "parameters": [ { @@ -754297,22 +767683,125 @@ } }, { - "name": "subject_digest", - "description": "Subject Digest", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { - "type": "string" - }, - "x-multi-segment": true + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { "200": { - "description": "Response" + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } }, - "204": { - "description": "Response" + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } }, "404": { "description": "Resource not found", @@ -754342,24 +767831,21 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "attestations" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/users/{username}/attestations/{attestation_id}": { - "delete": { - "summary": "Delete attestations by ID", - "description": "Delete an artifact attestation by unique ID that is associated with a repository owned by a user.", + }, + "put": { + "summary": "Set a resource for a Copilot Space for a user", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/delete-attestations-by-id", + "operationId": "copilot-spaces/update-resource-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/users/attestations#delete-attestations-by-id" + "url": "https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-a-copilot-space-for-a-user" }, "parameters": [ { @@ -754372,8 +767858,17 @@ } }, { - "name": "attestation_id", - "description": "Attestation ID", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", "in": "path", "required": true, "schema": { @@ -754381,12 +767876,108 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "Updated resource-specific metadata.", + "additionalProperties": true + } + } + }, + "examples": { + "default": { + "value": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + } + } + } + } + } + }, "responses": { "200": { - "description": "Response" - }, - "204": { - "description": "Response" + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" + } + } + } + } + } }, "403": { "description": "Forbidden", @@ -754439,56 +768030,101 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "attestations" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/users/{username}/attestations/{subject_digest}": { - "get": { - "summary": "List attestations", - "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + }, + "delete": { + "summary": "Delete a resource from a Copilot Space for a user", + "description": "Deletes a resource from a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/list-attestations", + "operationId": "copilot-spaces/delete-resource-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/users/attestations#list-attestations" + "url": "https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-a-copilot-space-for-a-user" }, "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, { "name": "username", "description": "The handle for the GitHub user account.", @@ -754499,226 +768135,54 @@ } }, { - "name": "subject_digest", - "description": "Subject Digest", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { - "type": "string" - }, - "x-multi-segment": true + "type": "integer" + } }, { - "name": "predicate_type", - "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", - "in": "query", - "required": false, + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "attestations": { - "type": "array", - "items": { - "type": "object", - "properties": { - "bundle": { - "type": "object", - "properties": { - "mediaType": { - "type": "string" - }, - "verificationMaterial": { - "type": "object", - "properties": {}, - "additionalProperties": true - }, - "dsseEnvelope": { - "type": "object", - "properties": {}, - "additionalProperties": true - } - }, - "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." - }, - "repository_id": { - "type": "integer" - }, - "bundle_url": { - "type": "string" - }, - "initiator": { - "type": "string" - } - } - } - } - } - }, - "examples": { - "default": { - "value": { - "attestations": [ - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - }, - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - } - ] + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "204": { - "description": "Response" - }, "404": { "description": "Resource not found", "content": { @@ -754747,10 +768211,9 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "attestations" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" } } }, @@ -797571,7 +811034,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1028494,7 +1041957,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1031625,7 +1045088,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1034661,7 +1048124,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1037697,7 +1051160,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1040867,7 +1054330,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1044044,7 +1057507,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1049232,7 +1062695,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 0fd310ec3a..d8f4e05b86 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -73,10 +73,15 @@ tags: description: Interact with GitHub Teams. - name: users description: Interact with and view information about users and also current user. +- name: code-quality + description: Insights into reliability, maintainability, and efficiency of your + codebase. - name: codespaces description: Endpoints to manage Codespaces using the REST API. - name: copilot description: Endpoints to manage Copilot using the REST API. +- name: copilot-spaces + description: Endpoints to manage Copilot Spaces using the REST API. - name: security-advisories description: Manage security advisories. - name: interactions @@ -907,7 +912,7 @@ paths: - subscriptions_url - type - url - type: &316 + type: &320 type: string description: The type of credit the user is receiving. enum: @@ -1073,7 +1078,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &640 + - &644 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1658,7 +1663,7 @@ paths: schema: type: integer default: 30 - - &206 + - &210 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1667,7 +1672,7 @@ paths: required: false schema: type: string - - &207 + - &211 name: status description: Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries @@ -1687,7 +1692,7 @@ paths: application/json: schema: type: array - items: &208 + items: &212 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1783,7 +1788,7 @@ paths: - installation_id - repository_id examples: - default: &209 + default: &213 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1918,7 +1923,7 @@ paths: description: Response content: application/json: - schema: &210 + schema: &214 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -2053,7 +2058,7 @@ paths: - request - response examples: - default: &211 + default: &215 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2594,7 +2599,7 @@ paths: organization_copilot_agent_settings: type: string description: The level of permission to grant the access - token to view and manage Copilot coding agent settings + token to view and manage Copilot cloud agent settings for an organization. enum: - read @@ -9531,9 +9536,9 @@ paths: put: summary: Set the coding agent policy for an enterprise description: |- - Sets the policy for Copilot coding agent usage across an enterprise. + Sets the policy for Copilot cloud agent usage across an enterprise. - Enterprise owners can configure whether Copilot coding agent is enabled for all + Enterprise owners can configure whether Copilot cloud agent is enabled for all organizations, disabled for all organizations, configured by individual organization admins, or enabled for selected organizations only. @@ -9558,7 +9563,7 @@ paths: properties: policy_state: type: string - description: The policy state for Copilot coding agent in the enterprise. + description: The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`. enum: @@ -9584,7 +9589,7 @@ paths: post: summary: Add organizations to the enterprise coding agent policy description: |- - Enables Copilot coding agent for the specified organizations within the enterprise. + Enables Copilot cloud agent for the specified organizations within the enterprise. The enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before using this endpoint. Organizations can be specified by login or matched via custom properties. @@ -9603,7 +9608,7 @@ paths: parameters: - *38 requestBody: - description: The organizations to enable Copilot coding agent for + description: The organizations to enable Copilot cloud agent for required: true content: application/json: @@ -9613,7 +9618,7 @@ paths: organizations: type: array description: List of organization logins within the enterprise to - enable Copilot coding agent for. + enable Copilot cloud agent for. items: type: string custom_properties: @@ -9659,7 +9664,7 @@ paths: delete: summary: Remove organizations from the enterprise coding agent policy description: |- - Disables Copilot coding agent for the specified organizations within the enterprise. + Disables Copilot cloud agent for the specified organizations within the enterprise. The enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before using this endpoint. Organizations can be specified by login or matched via custom properties. @@ -9678,7 +9683,7 @@ paths: parameters: - *38 requestBody: - description: The organizations to disable Copilot coding agent for + description: The organizations to disable Copilot cloud agent for required: true content: application/json: @@ -9688,7 +9693,7 @@ paths: organizations: type: array description: List of organization logins within the enterprise to - disable Copilot coding agent for. + disable Copilot cloud agent for. items: type: string custom_properties: @@ -9751,7 +9756,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *38 - - &189 + - &193 name: classification in: query description: |- @@ -9760,7 +9765,7 @@ paths: Can be: `malware`, `general` schema: type: string - - &190 + - &194 name: state in: query description: |- @@ -9769,7 +9774,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &191 + - &195 name: severity in: query description: |- @@ -9778,7 +9783,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &192 + - &196 name: ecosystem in: query description: |- @@ -9787,14 +9792,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &193 + - &197 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &194 + - &198 name: epss_percentage in: query description: |- @@ -9806,7 +9811,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &475 + - &479 name: has in: query description: |- @@ -9820,7 +9825,7 @@ paths: type: string enum: - patch - - &195 + - &199 name: assignee in: query description: |- @@ -9829,7 +9834,7 @@ paths: Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. schema: type: string - - &196 + - &200 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -9839,7 +9844,7 @@ paths: enum: - development - runtime - - &197 + - &201 name: sort in: query description: |- @@ -9865,7 +9870,7 @@ paths: application/json: schema: type: array - items: &198 + items: &202 type: object description: A Dependabot alert. properties: @@ -9936,7 +9941,7 @@ paths: - transitive - inconclusive - - security_advisory: &476 + security_advisory: &480 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -10211,7 +10216,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &477 + auto_dismissed_at: &481 type: - string - 'null' @@ -10219,7 +10224,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissal_request: &478 + dismissal_request: &482 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -10282,7 +10287,7 @@ paths: - repository additionalProperties: false examples: - default: &199 + default: &203 value: - number: 2 state: dismissed @@ -10667,7 +10672,7 @@ paths: description: Response content: application/json: - schema: &200 + schema: &204 title: Dependabot Repository Access Details description: Information about repositories that Dependabot is able to access in an organization @@ -10693,7 +10698,7 @@ paths: - *65 additionalProperties: false examples: - default: &201 + default: &205 value: default_level: public accessible_repositories: @@ -11907,7 +11912,7 @@ paths: properties: action: type: string - discussion: &730 + discussion: &735 title: Discussion description: A Discussion in a repository. type: object @@ -12408,7 +12413,7 @@ paths: milestone: anyOf: - type: 'null' - - &268 + - &272 title: Milestone description: A collection of related issues and pull requests. @@ -12580,7 +12585,7 @@ paths: timeline_url: type: string format: uri - type: &232 + type: &236 title: Issue Type description: The type of issue. type: @@ -12691,7 +12696,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &651 + sub_issues_summary: &655 title: Sub-issues Summary type: object properties: @@ -12775,7 +12780,7 @@ paths: pin: anyOf: - type: 'null' - - &550 + - &554 title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. @@ -12802,7 +12807,7 @@ paths: - url - created_at - updated_at - issue_dependencies_summary: &652 + issue_dependencies_summary: &656 title: Issue Dependencies Summary type: object properties: @@ -12821,7 +12826,7 @@ paths: - total_blocking issue_field_values: type: array - items: &534 + items: &538 title: Issue Field Value description: A value assigned to an issue field type: object @@ -13602,7 +13607,7 @@ paths: type: string release: allOf: - - &582 + - &586 title: Release description: A release. type: object @@ -13684,7 +13689,7 @@ paths: author: *4 assets: type: array - items: &583 + items: &587 title: Release Asset description: Data related to a release. type: object @@ -14287,7 +14292,7 @@ paths: url: type: string format: uri - user: &658 + user: &662 title: Public User description: Public User type: object @@ -16177,7 +16182,7 @@ paths: - closed - all default: open - - &235 + - &239 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -16228,7 +16233,7 @@ paths: type: array items: *82 examples: - default: &236 + default: &240 value: - id: 1 node_id: MDU6SXNzdWUx @@ -17640,14 +17645,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &327 + - &331 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &328 + - &332 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -17709,7 +17714,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &331 + '301': &335 description: Moved permanently content: application/json: @@ -17731,7 +17736,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &558 + - &562 name: all description: If `true`, show notifications marked as read. in: query @@ -17739,7 +17744,7 @@ paths: schema: type: boolean default: false - - &559 + - &563 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -17749,7 +17754,7 @@ paths: type: boolean default: false - *87 - - &560 + - &564 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -18131,7 +18136,7 @@ paths: type: boolean examples: - false - security_and_analysis: &283 + security_and_analysis: &287 type: - object - 'null' @@ -18342,7 +18347,7 @@ paths: - url - subscription_url examples: - default: &561 + default: &565 value: - id: '1' repository: @@ -19646,7 +19651,7 @@ paths: required: false schema: type: string - - &707 + - &712 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -19792,7 +19797,7 @@ paths: parameters: - *74 - *116 - - &708 + - &713 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -19904,7 +19909,7 @@ paths: - *116 - *118 - *117 - - &709 + - &714 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -19912,7 +19917,7 @@ paths: schema: type: string - *119 - - &710 + - &715 name: sku description: The SKU to query for usage. in: query @@ -20891,7 +20896,7 @@ paths: type: integer repository_cache_usages: type: array - items: &338 + items: &342 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -22159,6 +22164,12 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the + name-based format. + type: boolean required: - include_claim_keys examples: @@ -22200,6 +22211,12 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the name-based + format. + type: boolean examples: default: *136 responses: @@ -22267,7 +22284,7 @@ paths: - all - local_only - selected - selected_actions_url: &344 + selected_actions_url: &348 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` @@ -22350,7 +22367,7 @@ paths: description: Response content: application/json: - schema: &348 + schema: &352 type: object properties: days: @@ -22392,7 +22409,7 @@ paths: required: true content: application/json: - schema: &349 + schema: &353 type: object properties: days: @@ -22449,7 +22466,7 @@ paths: required: - approval_policy examples: - default: &350 + default: &354 value: approval_policy: first_time_contributors '404': *6 @@ -22508,7 +22525,7 @@ paths: description: Response content: application/json: - schema: &351 + schema: &355 type: object required: - run_workflows_from_fork_pull_requests @@ -22562,7 +22579,7 @@ paths: required: true content: application/json: - schema: &352 + schema: &356 type: object required: - run_workflows_from_fork_pull_requests @@ -23197,7 +23214,7 @@ paths: description: Response content: application/json: - schema: &353 + schema: &357 type: object properties: default_workflow_permissions: &146 @@ -23248,7 +23265,7 @@ paths: required: false content: application/json: - schema: &354 + schema: &358 type: object properties: default_workflow_permissions: *146 @@ -23741,7 +23758,7 @@ paths: type: array items: *153 examples: - default: &188 + default: &192 value: total_count: 1 repositories: @@ -24388,7 +24405,7 @@ paths: application/json: schema: type: array - items: &355 + items: &359 title: Runner Application description: Runner Application type: object @@ -24413,7 +24430,7 @@ paths: - download_url - filename examples: - default: &356 + default: &360 value: - os: osx architecture: x64 @@ -24499,7 +24516,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &357 + '201': &361 description: Response content: application/json: @@ -24614,7 +24631,7 @@ paths: - token - expires_at examples: - default: &358 + default: &362 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -24653,7 +24670,7 @@ paths: application/json: schema: *157 examples: - default: &359 + default: &363 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -24687,7 +24704,7 @@ paths: application/json: schema: *155 examples: - default: &360 + default: &364 value: id: 23 name: MBP @@ -24913,7 +24930,7 @@ paths: - *74 - *154 responses: - '200': &361 + '200': &365 description: Response content: application/json: @@ -24970,7 +24987,7 @@ paths: parameters: - *74 - *154 - - &362 + - &366 name: name description: The name of a self-hosted runner's custom label. in: path @@ -25102,7 +25119,7 @@ paths: description: Response content: application/json: - schema: &374 + schema: &378 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -25137,7 +25154,7 @@ paths: - key_id - key examples: - default: &375 + default: &379 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -25550,7 +25567,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *74 - - &343 + - &347 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -26783,12 +26800,12 @@ paths: required: - subject_digests examples: - default: &689 + default: &693 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &690 + withPredicateType: &694 value: subject_digests: - sha256:abc123 @@ -26847,7 +26864,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &691 + default: &695 value: attestations_subject_digests: - sha256:abc: @@ -27198,7 +27215,7 @@ paths: initiator: type: string examples: - default: &388 + default: &392 value: attestations: - bundle: @@ -27474,7 +27491,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &187 + items: &191 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -27551,7 +27568,7 @@ paths: parent: anyOf: - type: 'null' - - &247 + - &251 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -28154,7 +28171,7 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *74 - - &412 + - &416 name: tool_name description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, @@ -28164,7 +28181,7 @@ paths: schema: &178 type: string description: The name of the tool used to generate the code scanning analysis. - - &413 + - &417 name: tool_guid description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in @@ -28188,7 +28205,7 @@ paths: be returned. in: query required: false - schema: &415 + schema: &419 type: string description: State of a code scanning alert. enum: @@ -28211,7 +28228,7 @@ paths: be returned. in: query required: false - schema: &416 + schema: &420 type: string description: Severity of a code scanning alert. enum: @@ -28245,7 +28262,7 @@ paths: updated_at: *173 url: *174 html_url: *175 - instances_url: &417 + instances_url: &421 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -28267,7 +28284,7 @@ paths: - type: 'null' - *4 dismissed_at: *177 - dismissed_reason: &418 + dismissed_reason: &422 type: - string - 'null' @@ -28278,14 +28295,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &419 + dismissed_comment: &423 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &420 + rule: &424 type: object properties: id: @@ -28346,7 +28363,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &421 + tool: &425 type: object properties: name: *178 @@ -28357,26 +28374,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *179 - most_recent_instance: &422 + most_recent_instance: &426 type: object properties: - ref: &414 + ref: &418 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &432 + analysis_key: &436 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - environment: &433 + environment: &437 type: string description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &434 + category: &438 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -28396,7 +28413,7 @@ paths: with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance. - location: &435 + location: &439 type: object description: Describe a region within a file for the alert. properties: @@ -28417,7 +28434,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: &436 + items: &440 type: - string - 'null' @@ -29718,7 +29735,7 @@ paths: type: integer codespaces: type: array - items: &237 + items: &241 type: object title: Codespace description: A codespace. @@ -29753,7 +29770,7 @@ paths: machine: anyOf: - type: 'null' - - &448 + - &452 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -30040,7 +30057,7 @@ paths: - pulls_url - recent_folders examples: - default: &238 + default: &242 value: total_count: 3 codespaces: @@ -30705,7 +30722,7 @@ paths: - updated_at - visibility examples: - default: &449 + default: &453 value: total_count: 2 secrets: @@ -30743,7 +30760,7 @@ paths: description: Response content: application/json: - schema: &450 + schema: &454 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -30778,7 +30795,7 @@ paths: - key_id - key examples: - default: &451 + default: &455 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -30810,7 +30827,7 @@ paths: application/json: schema: *186 examples: - default: &453 + default: &457 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -31092,6 +31109,1597 @@ paths: enabledForGitHubApps: false category: codespaces subcategory: organization-secrets + "/orgs/{org}/copilot-spaces": + get: + summary: List organization Copilot Spaces + description: |- + Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces. + + Only Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-organization-copilot-spaces + parameters: + - *74 + - name: per_page + description: The number of results per page (max 100). + in: query + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: before + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + in: query + schema: + type: string + - name: after + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. + in: query + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - spaces + properties: + spaces: + type: array + description: The list of Copilot Spaces on this page of results. + items: &187 + title: Space + description: A GitHub Copilot Space represents an interactive + AI workspace where users can ask questions and get assistance. + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the space. + examples: + - 42 + number: + type: integer + description: The number that identifies the space within + its owner. + examples: + - 1 + name: + type: string + description: The display name of the space. + examples: + - My Development Space + description: + type: + - string + - 'null' + description: A description of the space. + examples: + - A space for discussing React development patterns + general_instructions: + type: + - string + - 'null' + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Help with React development patterns and best practices + base_role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: |- + The base role that determines default permissions. + - `no_access`: No default access + - `reader`: Default read permissions + - `writer`: Default write permissions (organization spaces only) + - `admin`: Default admin permissions (organization spaces only) + examples: + - no_access + owner: + anyOf: + - *4 + - *72 + description: The user or organization that owns this space. + creator: *4 + created_at: + type: string + format: date-time + description: The date and time the space was created. + examples: + - '2023-01-01T00:00:00Z' + updated_at: + type: string + format: date-time + description: The date and time the space was last updated. + examples: + - '2023-01-01T12:00:00Z' + html_url: + type: string + format: uri + description: The HTML URL of the space. + examples: + - https://github.com/copilot/spaces/octo-org/5 + api_url: + type: string + format: uri + description: The API URL of the space. + examples: + - https://api.github.com/organizations/1/copilot-spaces/5 + resources_attributes: + type: array + description: Resources attached to the space. + items: + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the resource. + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + copilot_chat_attachment_id: + type: + - integer + - 'null' + format: int64 + description: The unique identifier of the chat attachment + for uploaded files or media content. + created_at: + type: string + format: date-time + description: The date and time the resource was created. + updated_at: + type: string + format: date-time + description: The date and time the resource was last + updated. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file + resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + copilot_chat_attachment_id: + type: integer + description: Chat attachment ID for uploaded files + or media. + media_type: + type: string + description: Media type for media content resources. + url: + type: string + description: URL for media content resources. + height: + type: integer + description: Height for media content resources. + width: + type: integer + description: Width for media content resources. + required: + - id + - number + - name + - base_role + - owner + - creator + - created_at + - updated_at + - html_url + - api_url + additionalProperties: false + examples: + default: + summary: Example response for listing organization copilot spaces + value: + spaces: + - id: 84 + number: 3 + name: Team Planning Space + description: Organization space for team planning and coordination + owner: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + gravatar_id: '' + name: octo-org + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: octo-org + html_url: https://github.com/octo-org + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + creator: + login: defunkt + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://github.com/images/error/defunkt_happy.gif + gravatar_id: '' + url: https://api.github.com/users/defunkt + html_url: https://github.com/defunkt + followers_url: https://api.github.com/users/defunkt/followers + following_url: https://api.github.com/users/defunkt/following{/other_user} + gists_url: https://api.github.com/users/defunkt/gists{/gist_id} + starred_url: https://api.github.com/users/defunkt/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/defunkt/subscriptions + organizations_url: https://api.github.com/users/defunkt/orgs + repos_url: https://api.github.com/users/defunkt/repos + events_url: https://api.github.com/users/defunkt/events{/privacy} + received_events_url: https://api.github.com/users/defunkt/received_events + type: User + site_admin: true + created_at: '2023-02-15T08:30:00Z' + updated_at: '2023-02-15T14:45:00Z' + html_url: https://github.com/copilot/spaces/octo-org/3 + api_url: https://api.github.com/organizations/1/copilot-spaces/3 + - id: 85 + number: 4 + name: Development Resources + description: Shared development documentation and resources + owner: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + gravatar_id: '' + name: octo-org + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: octo-org + html_url: https://github.com/octo-org + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + creator: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-16T10:15:00Z' + updated_at: '2023-02-16T16:30:00Z' + html_url: https://github.com/copilot/spaces/octo-org/4 + api_url: https://api.github.com/organizations/1/copilot-spaces/4 + headers: + Link: *66 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + post: + summary: Create an organization Copilot Space + description: |- + Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization. + + Organization members with appropriate permissions can create Copilot Spaces to be shared within their organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-an-organization-copilot-space + parameters: + - *74 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - Team Planning Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Organization space for team planning and coordination + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Help the team with planning and coordination tasks + base_role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: |- + The base role that determines default permissions for organization members. + - `no_access`: No default access (default) + - `reader`: Organization members can read the space + - `writer`: Organization members can read and edit the space + - `admin`: Organization members have full admin access to the space + default: no_access + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + required: + - name + examples: + default: + value: + name: Team Planning Space + description: Organization space for team planning and coordination + general_instructions: Help the team with planning and coordination + tasks + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 123456 + file_path: docs/planning.md + - resource_type: free_text + metadata: + name: Team Guidelines + text: Our team follows agile methodology and holds daily standups + responses: + '201': + description: Response + content: + application/json: + schema: *187 + examples: + default: &188 + summary: Example response for an organization copilot space + value: + id: 84 + number: 3 + name: Team Planning Space + description: Organization space for team planning and coordination + general_instructions: Help the team with agile planning, sprint + coordination, and project management best practices + owner: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + gravatar_id: '' + name: octo-org + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: octo-org + html_url: https://github.com/octo-org + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + creator: + login: defunkt + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://github.com/images/error/defunkt_happy.gif + gravatar_id: '' + url: https://api.github.com/users/defunkt + html_url: https://github.com/defunkt + followers_url: https://api.github.com/users/defunkt/followers + following_url: https://api.github.com/users/defunkt/following{/other_user} + gists_url: https://api.github.com/users/defunkt/gists{/gist_id} + starred_url: https://api.github.com/users/defunkt/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/defunkt/subscriptions + organizations_url: https://api.github.com/users/defunkt/orgs + repos_url: https://api.github.com/users/defunkt/repos + events_url: https://api.github.com/users/defunkt/events{/privacy} + received_events_url: https://api.github.com/users/defunkt/received_events + type: User + site_admin: true + created_at: '2023-02-15T08:30:00Z' + updated_at: '2023-02-15T14:45:00Z' + html_url: https://github.com/copilot/spaces/octo-org/3 + api_url: https://api.github.com/organizations/1/copilot-spaces/3 + base_role: no_access + resources_attributes: + - id: 123 + resource_type: github_file + metadata: + repository_id: 456 + file_path: docs/planning.md + - id: 124 + resource_type: free_text + metadata: + name: Team Guidelines + text: Our team follows agile methodology + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + "/orgs/{org}/copilot-spaces/{space_number}": + get: + summary: Get an organization Copilot Space + description: |- + Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space. + + Internal Spaces require the authenticated user to be a member of the organization or have been granted read permissions. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *187 + examples: + default: *188 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + put: + summary: Set an organization Copilot Space + description: |- + Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization. + + Organization members with appropriate permissions can update Copilot Spaces owned by their organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - Updated Team Planning Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Updated organization space for team planning and coordination + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Updated instructions to help the team with planning and coordination + tasks + base_role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: |- + The base role that determines default permissions for organization members. Changing this field requires admin permissions. + - `no_access`: No default access (default) + - `reader`: Organization members can read the space + - `writer`: Organization members can read and edit the space + - `admin`: Organization members have full admin access to the space + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + examples: + default: + value: + name: Updated Team Planning Space + description: Updated organization space for team planning and coordination + general_instructions: Updated instructions to help the team with + planning and coordination tasks + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 123456 + file_path: docs/updated-planning.md + - id: 789 + _destroy: true + - id: 456 + resource_type: free_text + metadata: + name: Updated Team Guidelines + text: Our updated team follows agile methodology and holds daily + standups + responses: + '200': + description: Response + content: + application/json: + schema: *187 + examples: + default: *188 + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + delete: + summary: Delete an organization Copilot Space + description: |- + Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization. + + **Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations. + + Organization members with appropriate permissions can delete Copilot Spaces owned by their organization. + + OAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '204': + description: The Copilot Space has been successfully deleted. + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + "/orgs/{org}/copilot-spaces/{space_number}/collaborators": + get: + summary: List collaborators for an organization Copilot Space + description: |- + Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators. + + Each collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list. + + **Note:** Team collaborators listed here are teams that are defined in the organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-collaborators-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - collaborators + properties: + collaborators: + type: array + description: The list of collaborators for this Copilot Space. + items: &189 + title: Copilot Space Collaborator + description: A collaborator (user or team) of a Copilot Space + type: object + anyOf: + - allOf: + - *4 + - type: object + properties: + actor_type: + type: string + enum: + - User + description: The collaborator actor type. + role: + type: string + enum: + - reader + - writer + - admin + description: The role granted to the collaborator + required: + - actor_type + - role + - type: object + properties: + actor_type: + type: string + enum: + - Team + description: The collaborator actor type. + role: + type: string + enum: + - reader + - writer + - admin + description: The role granted to the collaborator + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + type: + type: string + enum: + - Team + description: + type: + - string + - 'null' + privacy: + type: string + notification_setting: + type: string + url: + type: string + format: uri + html_url: + type: string + format: uri + members_url: + type: string + repositories_url: + type: string + format: uri + organization_id: + type: integer + parent: + type: + - 'null' + required: + - actor_type + - role + - id + - node_id + - name + - slug + - type + examples: + default: + value: + collaborators: + - actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + - actor_type: Team + role: reader + id: 67890 + node_id: MDQ6VGVhbTY3ODkw + url: https://api.github.com/teams/67890 + html_url: https://github.com/orgs/octo-org/teams/developers + name: Developers + slug: developers + description: Team of developers + privacy: closed + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/67890/members{/member} + repositories_url: https://api.github.com/teams/67890/repos + parent: + created_at: '2017-07-14T16:53:42Z' + updated_at: '2017-08-17T12:37:15Z' + organization: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + post: + summary: Add a collaborator to an organization Copilot Space + description: |- + Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. + + **Note:** When adding users as collaborators, they must already be members of the organization. + When adding teams as collaborators, they must be defined in the organization. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/add-collaborator-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - actor_type + - actor_identifier + - role + properties: + actor_type: + type: string + enum: + - User + - Team + description: The type of actor (user or team). + actor_identifier: + type: string + description: The username (for users) or team slug (for teams). + The numeric ID of a user or team is also accepted. + role: + type: string + enum: + - reader + - writer + - admin + description: The role to grant to the collaborator. + examples: + user: + value: + actor_type: User + actor_identifier: octocat + role: writer + team: + value: + actor_type: Team + actor_identifier: developers + role: reader + responses: + '201': + description: Response + content: + application/json: + schema: *189 + examples: + user: + value: + actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + team: + value: + actor_type: Team + role: reader + id: 67890 + node_id: MDQ6VGVhbTY3ODkw + url: https://api.github.com/teams/67890 + html_url: https://github.com/orgs/octo-org/teams/developers + name: Developers + slug: developers + type: Team + description: Team of developers + privacy: closed + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/67890/members{/member} + repositories_url: https://api.github.com/teams/67890/repos + parent: + organization_id: 1 + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": + put: + summary: Set a collaborator role for an organization Copilot Space + description: |- + Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-collaborator-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (user or team). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username (for users) or team slug (for teams). The numeric + ID of a user or team is also accepted. + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - role + properties: + role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: The new role to grant to the collaborator. Use `no_access` + to remove the collaborator. + examples: + default: + value: + role: admin + responses: + '200': + description: Response + content: + application/json: + schema: *189 + examples: + user: + value: + actor_type: User + role: admin + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + team: + value: + actor_type: Team + role: admin + id: 67890 + node_id: MDQ6VGVhbTY3ODkw + url: https://api.github.com/teams/67890 + html_url: https://github.com/orgs/octo-org/teams/developers + name: Developers + slug: developers + type: Team + description: Team of developers + privacy: closed + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/67890/members{/member} + repositories_url: https://api.github.com/teams/67890/repos + parent: + organization_id: 1 + '204': + description: Response when `role` is `no_access` and the collaborator was + removed. + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + delete: + summary: Remove a collaborator from an organization Copilot Space + description: |- + Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/remove-collaborator-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (user or team). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username (for users) or team slug (for teams). The numeric + ID of a user or team is also accepted. + in: path + required: true + schema: + type: string + responses: + '204': + description: Response + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + "/orgs/{org}/copilot-spaces/{space_number}/resources": + get: + summary: List resources for an organization Copilot Space + description: |- + Lists all resources attached to a specific Copilot Space owned by an organization. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-resources-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - resources + properties: + resources: + type: array + description: The list of resources attached to this Copilot Space. + items: &190 + title: Copilot Space Resource + description: A resource attached to a Copilot Space. + type: object + properties: + id: + type: integer + description: The unique identifier of the resource. + resource_type: + type: string + description: The type of the resource. + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + copilot_chat_attachment_id: + type: + - integer + - 'null' + description: The ID of the associated chat attachment, if + any. + metadata: + type: object + description: Resource-specific metadata. The keys and values + depend on the resource type. + additionalProperties: true + created_at: + type: string + format: date-time + description: The date and time the resource was created. + updated_at: + type: string + format: date-time + description: The date and time the resource was last updated. + required: + - id + - resource_type + - metadata + - created_at + - updated_at + examples: + default: + value: + resources: + - id: 1 + resource_type: repository + copilot_chat_attachment_id: + metadata: + repository_id: 42 + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + - id: 2 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + post: + summary: Create a resource for an organization Copilot Space + description: |- + Creates a new resource in a specific Copilot Space owned by an organization. + The authenticated user must have write permissions on the space. + + The following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`. + The `uploaded_text_file` and `media_content` types are not supported via this endpoint. + + For `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - resource_type + - metadata + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + description: The type of resource to create. + metadata: + type: object + description: Resource-specific metadata. + additionalProperties: true + examples: + free_text: + value: + resource_type: free_text + metadata: + name: notes.txt + text: Some helpful notes + repository: + value: + resource_type: repository + metadata: + repository_id: 42 + github_file: + value: + resource_type: github_file + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + responses: + '201': + description: Resource created + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '200': + description: Duplicate github_file resource already exists + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: github_file + copilot_chat_attachment_id: + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": + get: + summary: Get a resource for an organization Copilot Space + description: |- + Gets a specific resource attached to a Copilot Space owned by an organization. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + put: + summary: Set a resource for an organization Copilot Space + description: |- + Updates the metadata of a resource in a specific Copilot Space owned by an organization. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + description: Updated resource-specific metadata. + additionalProperties: true + examples: + default: + value: + metadata: + name: updated-notes.txt + text: Updated content + responses: + '200': + description: Response + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: updated-notes.txt + text: Updated content + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T12:00:00Z' + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + delete: + summary: Delete a resource from an organization Copilot Space + description: |- + Deletes a resource from a specific Copilot Space owned by an organization. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources "/orgs/{org}/copilot/billing": get: summary: Get Copilot seat information and settings for an organization @@ -31277,7 +32885,7 @@ paths: currently being billed. seats: type: array - items: &240 + items: &244 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -31295,7 +32903,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *187 + - *191 - *67 type: - 'null' @@ -31754,15 +33362,15 @@ paths: subcategory: copilot-user-management "/orgs/{org}/copilot/coding-agent/permissions": get: - summary: Get Copilot coding agent permissions for an organization + summary: Get Copilot cloud agent permissions for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Gets information about which repositories in an organization have been enabled - or disabled for the Copilot coding agent. + or disabled for the Copilot cloud agent. - Organization owners can configure whether Copilot coding agent is enabled for + Organization owners can configure whether Copilot cloud agent is enabled for all repositories, selected repositories, or no repositories owned by organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -31771,7 +33379,7 @@ paths: operationId: copilot/get-copilot-coding-agent-permissions-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-cloud-agent-permissions-for-an-organization parameters: - *74 responses: @@ -31785,7 +33393,7 @@ paths: enabled_repositories: type: string description: The policy for which repositories can use Copilot - coding agent. Can be one of `all`, `selected`, or `none`. + cloud agent. Can be one of `all`, `selected`, or `none`. enum: - all - selected @@ -31820,14 +33428,14 @@ paths: category: copilot subcategory: copilot-coding-agent-management put: - summary: Set Copilot coding agent permissions for an organization + summary: Set Copilot cloud agent permissions for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. - Sets the policy for which repositories in an organization can use Copilot coding agent. + Sets the policy for which repositories in an organization can use Copilot cloud agent. - Organization owners can configure whether Copilot coding agent is enabled for + Organization owners can configure whether Copilot cloud agent is enabled for all repositories, selected repositories, or no repositories owned by the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -31836,7 +33444,7 @@ paths: operationId: copilot/set-copilot-coding-agent-permissions-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-cloud-agent-permissions-for-an-organization parameters: - *74 requestBody: @@ -31848,7 +33456,7 @@ paths: properties: enabled_repositories: type: string - description: The policy for which repositories can use Copilot coding + description: The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`. enum: - all @@ -31875,12 +33483,12 @@ paths: subcategory: copilot-coding-agent-management "/orgs/{org}/copilot/coding-agent/permissions/repositories": get: - summary: List repositories enabled for Copilot coding agent in an organization + summary: List repositories enabled for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists the selected repositories that are enabled for Copilot coding agent in an organization. + Lists the selected repositories that are enabled for Copilot cloud agent in an organization. Organization owners can use this endpoint when the coding agent repository policy is set to `selected` to see which repositories have been enabled. @@ -31891,7 +33499,7 @@ paths: operationId: copilot/list-copilot-coding-agent-selected-repositories-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-cloud-agent-in-an-organization parameters: - *74 - *17 @@ -31913,7 +33521,7 @@ paths: - total_count - repositories examples: - default: *188 + default: *192 '500': *53 '401': *23 '403': *27 @@ -31925,13 +33533,13 @@ paths: category: copilot subcategory: copilot-coding-agent-management put: - summary: Set selected repositories for Copilot coding agent in an organization + summary: Set selected repositories for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. - Replaces the list of selected repositories that are enabled for Copilot coding - agent in an organization. This method can only be called when the coding agent + Replaces the list of selected repositories that are enabled for Copilot cloud + agent in an organization. This method can only be called when the cloud agent repository policy is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -31940,7 +33548,7 @@ paths: operationId: copilot/set-copilot-coding-agent-selected-repositories-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-cloud-agent-in-an-organization parameters: - *74 requestBody: @@ -31951,7 +33559,7 @@ paths: type: object properties: selected_repository_ids: - description: List of repository IDs to enable for Copilot coding + description: List of repository IDs to enable for Copilot cloud agent. type: array items: @@ -31981,14 +33589,14 @@ paths: subcategory: copilot-coding-agent-management "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}": put: - summary: Enable a repository for Copilot coding agent in an organization + summary: Enable a repository for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Adds a repository to the list of selected repositories enabled for Copilot - coding agent in an organization. This method can only be called when the - coding agent repository policy is set to `selected`. + cloud agent in an organization. This method can only be called when the + cloud agent repository policy is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -31996,7 +33604,7 @@ paths: operationId: copilot/enable-copilot-coding-agent-for-repository-in-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-cloud-agent-in-an-organization parameters: - *74 - *142 @@ -32015,14 +33623,14 @@ paths: category: copilot subcategory: copilot-coding-agent-management delete: - summary: Disable a repository for Copilot coding agent in an organization + summary: Disable a repository for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Removes a repository from the list of selected repositories enabled for Copilot - coding agent in an organization. This method can only be called when the - coding agent repository policy is set to `selected`. + cloud agent in an organization. This method can only be called when the + cloud agent repository policy is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint. tags: @@ -32030,7 +33638,7 @@ paths: operationId: copilot/disable-copilot-coding-agent-for-repository-in-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-cloud-agent-in-an-organization parameters: - *74 - *142 @@ -32248,7 +33856,7 @@ paths: application/json: schema: type: array - items: &320 + items: &324 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -32563,7 +34171,7 @@ paths: - date additionalProperties: true examples: - default: &321 + default: &325 value: - date: '2024-06-24' total_active_users: 24 @@ -32665,7 +34273,7 @@ paths: '500': *53 '403': *27 '404': *6 - '422': &322 + '422': &326 description: Copilot Usage Metrics API setting is disabled at the organization or enterprise level. content: @@ -32845,12 +34453,12 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *74 - - *189 - - *190 - - *191 - - *192 - *193 - *194 + - *195 + - *196 + - *197 + - *198 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -32880,7 +34488,7 @@ paths: enum: - patch - deployment - - *195 + - *199 - name: runtime_risk in: query description: |- @@ -32889,8 +34497,8 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *196 - - *197 + - *200 + - *201 - *60 - *45 - *46 @@ -32902,9 +34510,9 @@ paths: application/json: schema: type: array - items: *198 + items: *202 examples: - default: *199 + default: *203 '304': *35 '400': *14 '403': *27 @@ -32953,9 +34561,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *204 examples: - default: *201 + default: *205 '403': *27 '404': *6 x-github: @@ -33119,7 +34727,7 @@ paths: type: integer secrets: type: array - items: &202 + items: &206 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -33198,7 +34806,7 @@ paths: description: Response content: application/json: - schema: &481 + schema: &485 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -33217,7 +34825,7 @@ paths: - key_id - key examples: - default: &482 + default: &486 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -33247,7 +34855,7 @@ paths: description: Response content: application/json: - schema: *202 + schema: *206 examples: default: value: @@ -33546,7 +35154,7 @@ paths: application/json: schema: type: array - items: &249 + items: &253 title: Package description: A software package type: object @@ -33617,7 +35225,7 @@ paths: - created_at - updated_at examples: - default: &250 + default: &254 value: - id: 197 name: hello_docker @@ -33787,7 +35395,7 @@ paths: application/json: schema: type: array - items: &226 + items: &230 title: Organization Invitation description: Organization Invitation type: object @@ -33841,7 +35449,7 @@ paths: - invitation_teams_url - node_id examples: - default: &227 + default: &231 value: - id: 1 login: monalisa @@ -33908,7 +35516,7 @@ paths: application/json: schema: type: array - items: &203 + items: &207 title: Org Hook description: Org Hook type: object @@ -34093,9 +35701,9 @@ paths: description: Response content: application/json: - schema: *203 + schema: *207 examples: - default: &204 + default: &208 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -34143,7 +35751,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - *74 - - &205 + - &209 name: hook_id description: The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. @@ -34156,9 +35764,9 @@ paths: description: Response content: application/json: - schema: *203 + schema: *207 examples: - default: *204 + default: *208 '404': *6 x-github: githubCloudOnly: false @@ -34186,7 +35794,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - *74 - - *205 + - *209 requestBody: required: false content: @@ -34232,7 +35840,7 @@ paths: description: Response content: application/json: - schema: *203 + schema: *207 examples: default: value: @@ -34274,7 +35882,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - *74 - - *205 + - *209 responses: '204': description: Response @@ -34302,7 +35910,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *74 - - *205 + - *209 responses: '200': description: Response @@ -34333,7 +35941,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *74 - - *205 + - *209 requestBody: required: false content: @@ -34384,10 +35992,10 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *74 - - *205 + - *209 - *17 - - *206 - - *207 + - *210 + - *211 responses: '200': description: Response @@ -34395,9 +36003,9 @@ paths: application/json: schema: type: array - items: *208 + items: *212 examples: - default: *209 + default: *213 '400': *14 '422': *15 x-github: @@ -34423,16 +36031,16 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *74 - - *205 + - *209 - *16 responses: '200': description: Response content: application/json: - schema: *210 + schema: *214 examples: - default: *211 + default: *215 '400': *14 '422': *15 x-github: @@ -34458,7 +36066,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *74 - - *205 + - *209 - *16 responses: '202': *37 @@ -34488,7 +36096,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - *74 - - *205 + - *209 responses: '204': description: Response @@ -34511,7 +36119,7 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - *74 - - &216 + - &220 name: actor_type in: path description: The type of the actor @@ -34524,14 +36132,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &217 + - &221 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &212 + - &216 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -34539,7 +36147,7 @@ paths: required: true schema: type: string - - &213 + - &217 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -34634,12 +36242,12 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - *74 - - *212 - - *213 + - *216 + - *217 - *19 - *17 - *60 - - &222 + - &226 name: sort description: The property to sort the results by. in: query @@ -34718,14 +36326,14 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - *74 - - *212 - - *213 + - *216 + - *217 responses: '200': description: Response content: application/json: - schema: &214 + schema: &218 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -34741,7 +36349,7 @@ paths: type: integer format: int64 examples: - default: &215 + default: &219 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -34762,23 +36370,23 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - *74 - - &218 + - &222 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *212 - - *213 + - *216 + - *217 responses: '200': description: Response content: application/json: - schema: *214 + schema: *218 examples: - default: *215 + default: *219 x-github: enabledForGitHubApps: true category: orgs @@ -34797,18 +36405,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - *74 - - *212 - - *213 - *216 - *217 + - *220 + - *221 responses: '200': description: Response content: application/json: - schema: *214 + schema: *218 examples: - default: *215 + default: *219 x-github: enabledForGitHubApps: true category: orgs @@ -34826,9 +36434,9 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - *74 - - *212 - - *213 - - &219 + - *216 + - *217 + - &223 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -34841,7 +36449,7 @@ paths: description: Response content: application/json: - schema: &220 + schema: &224 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -34857,7 +36465,7 @@ paths: type: integer format: int64 examples: - default: &221 + default: &225 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -34894,18 +36502,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - *74 - - *218 - - *212 - - *213 - - *219 + - *222 + - *216 + - *217 + - *223 responses: '200': description: Response content: application/json: - schema: *220 + schema: *224 examples: - default: *221 + default: *225 x-github: enabledForGitHubApps: true category: orgs @@ -34923,19 +36531,19 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - *74 + - *220 + - *221 - *216 - *217 - - *212 - - *213 - - *219 + - *223 responses: '200': description: Response content: application/json: - schema: *220 + schema: *224 examples: - default: *221 + default: *225 x-github: enabledForGitHubApps: true category: orgs @@ -34953,13 +36561,13 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - *74 - - *218 - - *212 - - *213 + - *222 + - *216 + - *217 - *19 - *17 - *60 - - *222 + - *226 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -35043,7 +36651,7 @@ paths: application/json: schema: *20 examples: - default: &521 + default: &525 value: id: 1 account: @@ -35209,12 +36817,12 @@ paths: application/json: schema: anyOf: - - &224 + - &228 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &223 + limit: &227 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -35242,7 +36850,7 @@ paths: properties: {} additionalProperties: false examples: - default: &225 + default: &229 value: limit: collaborators_only origin: organization @@ -35271,13 +36879,13 @@ paths: required: true content: application/json: - schema: &522 + schema: &526 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *223 + limit: *227 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -35302,9 +36910,9 @@ paths: description: Response content: application/json: - schema: *224 + schema: *228 examples: - default: *225 + default: *229 '422': *15 x-github: githubCloudOnly: false @@ -35380,9 +36988,9 @@ paths: application/json: schema: type: array - items: *226 + items: *230 examples: - default: *227 + default: *231 headers: Link: *66 '404': *6 @@ -35459,7 +37067,7 @@ paths: description: Response content: application/json: - schema: *226 + schema: *230 examples: default: value: @@ -35514,7 +37122,7 @@ paths: url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - *74 - - &228 + - &232 name: invitation_id description: The unique identifier of the invitation. in: path @@ -35545,7 +37153,7 @@ paths: url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - *74 - - *228 + - *232 - *17 - *19 responses: @@ -35555,9 +37163,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - default: &248 + default: &252 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -35600,7 +37208,7 @@ paths: application/json: schema: type: array - items: &229 + items: &233 title: Issue Field description: A custom attribute defined at the organization level for attaching structured data to issues. @@ -35843,9 +37451,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *233 examples: - default: &230 + default: &234 value: id: 512 node_id: IF_kwDNAd3NAZr @@ -35901,7 +37509,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-fields#update-issue-field-for-an-organization parameters: - *74 - - &231 + - &235 name: issue_field_id description: The unique identifier of the issue field. in: path @@ -36011,9 +37619,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *233 examples: - default: *230 + default: *234 '404': *6 '422': *7 x-github: @@ -36038,7 +37646,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-fields#delete-issue-field-for-an-organization parameters: - *74 - - *231 + - *235 responses: '204': *59 '404': *6 @@ -36068,7 +37676,7 @@ paths: application/json: schema: type: array - items: *232 + items: *236 examples: default: value: @@ -36156,9 +37764,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *236 examples: - default: &233 + default: &237 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -36191,7 +37799,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *74 - - &234 + - &238 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -36247,9 +37855,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *236 examples: - default: *233 + default: *237 '404': *6 '422': *7 x-github: @@ -36274,7 +37882,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *74 - - *234 + - *238 responses: '204': description: Response @@ -36337,7 +37945,7 @@ paths: - closed - all default: open - - *235 + - *239 - name: type description: Can be the name of an issue type. in: query @@ -36368,7 +37976,7 @@ paths: type: array items: *82 examples: - default: *236 + default: *240 headers: Link: *66 '404': *6 @@ -36527,9 +38135,9 @@ paths: type: integer codespaces: type: array - items: *237 + items: *241 examples: - default: *238 + default: *242 '304': *35 '500': *53 '401': *23 @@ -36556,7 +38164,7 @@ paths: parameters: - *74 - *70 - - &239 + - &243 name: codespace_name in: path required: true @@ -36591,15 +38199,15 @@ paths: parameters: - *74 - *70 - - *239 + - *243 responses: '200': description: Response content: application/json: - schema: *237 + schema: *241 examples: - default: &447 + default: &451 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -36779,7 +38387,7 @@ paths: description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *240 + schema: *244 examples: default: value: @@ -36855,7 +38463,7 @@ paths: description: Response content: application/json: - schema: &241 + schema: &245 title: Org Membership description: Org Membership type: object @@ -36924,7 +38532,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &242 + response-if-user-has-an-active-admin-membership-with-organization: &246 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -37025,9 +38633,9 @@ paths: description: Response content: application/json: - schema: *241 + schema: *245 examples: - response-if-user-already-had-membership-with-organization: *242 + response-if-user-already-had-membership-with-organization: *246 '422': *15 '403': *27 x-github: @@ -37099,7 +38707,7 @@ paths: application/json: schema: type: array - items: &243 + items: &247 title: Migration description: A migration. type: object @@ -37437,7 +39045,7 @@ paths: description: Response content: application/json: - schema: *243 + schema: *247 examples: default: value: @@ -37616,7 +39224,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - *74 - - &244 + - &248 name: migration_id description: The unique identifier of the migration. in: path @@ -37644,7 +39252,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *243 + schema: *247 examples: default: value: @@ -37814,7 +39422,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - *74 - - *244 + - *248 responses: '302': description: Response @@ -37836,7 +39444,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - *74 - - *244 + - *248 responses: '204': description: Response @@ -37860,8 +39468,8 @@ paths: url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - *74 - - *244 - - &672 + - *248 + - &676 name: repo_name description: repo_name parameter in: path @@ -37889,7 +39497,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - *74 - - *244 + - *248 - *17 - *19 responses: @@ -37901,7 +39509,7 @@ paths: type: array items: *153 examples: - default: &255 + default: &259 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -38056,7 +39664,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &246 + items: &250 title: Organization Role description: Organization roles type: object @@ -38233,7 +39841,7 @@ paths: parameters: - *74 - *76 - - &245 + - &249 name: role_id description: The unique identifier of the role. in: path @@ -38270,7 +39878,7 @@ paths: parameters: - *74 - *76 - - *245 + - *249 responses: '204': description: Response @@ -38323,7 +39931,7 @@ paths: parameters: - *74 - *70 - - *245 + - *249 responses: '204': description: Response @@ -38355,7 +39963,7 @@ paths: parameters: - *74 - *70 - - *245 + - *249 responses: '204': description: Response @@ -38384,13 +39992,13 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - *74 - - *245 + - *249 responses: '200': description: Response content: application/json: - schema: *246 + schema: *250 examples: default: value: @@ -38441,7 +40049,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - *74 - - *245 + - *249 - *17 - *19 responses: @@ -38520,7 +40128,7 @@ paths: parent: anyOf: - type: 'null' - - *247 + - *251 type: description: The ownership type of the team type: string @@ -38553,7 +40161,7 @@ paths: - type - parent examples: - default: *248 + default: *252 headers: Link: *66 '404': @@ -38583,7 +40191,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - *74 - - *245 + - *249 - *17 - *19 responses: @@ -38612,7 +40220,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *247 + items: *251 name: type: - string @@ -38922,7 +40530,7 @@ paths: - nuget - container - *74 - - &673 + - &677 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -38958,12 +40566,12 @@ paths: application/json: schema: type: array - items: *249 + items: *253 examples: - default: *250 + default: *254 '403': *27 '401': *23 - '400': &675 + '400': &679 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -38985,7 +40593,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &251 + - &255 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -39003,7 +40611,7 @@ paths: - docker - nuget - container - - &252 + - &256 name: package_name description: The name of the package. in: path @@ -39016,7 +40624,7 @@ paths: description: Response content: application/json: - schema: *249 + schema: *253 examples: default: value: @@ -39068,8 +40676,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *251 - - *252 + - *255 + - *256 - *74 responses: '204': @@ -39102,8 +40710,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *251 - - *252 + - *255 + - *256 - *74 - name: token description: package token @@ -39136,8 +40744,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *251 - - *252 + - *255 + - *256 - *74 - *19 - *17 @@ -39158,7 +40766,7 @@ paths: application/json: schema: type: array - items: &253 + items: &257 title: Package Version description: A version of a software package type: object @@ -39293,10 +40901,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *251 - - *252 + - *255 + - *256 - *74 - - &254 + - &258 name: package_version_id description: Unique identifier of the package version. in: path @@ -39308,7 +40916,7 @@ paths: description: Response content: application/json: - schema: *253 + schema: *257 examples: default: value: @@ -39344,10 +40952,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *251 - - *252 + - *255 + - *256 - *74 - - *254 + - *258 responses: '204': description: Response @@ -39379,10 +40987,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *251 - - *252 + - *255 + - *256 - *74 - - *254 + - *258 responses: '204': description: Response @@ -39412,7 +41020,7 @@ paths: - *74 - *17 - *19 - - &256 + - &260 name: sort description: The property by which to sort the results. in: query @@ -39423,7 +41031,7 @@ paths: - created_at default: created_at - *60 - - &257 + - &261 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -39435,7 +41043,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &258 + - &262 name: repository description: The name of the repository to use to filter the results. in: query @@ -39444,7 +41052,7 @@ paths: type: string examples: - Hello-World - - &259 + - &263 name: permission description: The permission to use to filter the results. in: query @@ -39453,7 +41061,7 @@ paths: type: string examples: - issues_read - - &260 + - &264 name: last_used_before description: 'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -39463,7 +41071,7 @@ paths: schema: type: string format: date-time - - &261 + - &265 name: last_used_after description: 'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -39473,7 +41081,7 @@ paths: schema: type: string format: date-time - - &262 + - &266 name: token_id description: The ID of the token in: query @@ -39792,7 +41400,7 @@ paths: type: array items: *153 examples: - default: *255 + default: *259 headers: Link: *66 x-github: @@ -39818,14 +41426,14 @@ paths: - *74 - *17 - *19 - - *256 - - *60 - - *257 - - *258 - - *259 - *260 + - *60 - *261 - *262 + - *263 + - *264 + - *265 + - *266 responses: '500': *53 '422': *15 @@ -40109,7 +41717,7 @@ paths: type: array items: *153 examples: - default: *255 + default: *259 headers: Link: *66 x-github: @@ -40151,7 +41759,7 @@ paths: type: integer configurations: type: array - items: &263 + items: &267 title: Organization private registry description: Private registry configuration for an organization type: object @@ -40628,7 +42236,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &264 + org-private-registry-with-selected-visibility: &268 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -40726,9 +42334,9 @@ paths: description: The specified private registry configuration for the organization content: application/json: - schema: *263 + schema: *267 examples: - default: *264 + default: *268 '404': *6 x-github: githubCloudOnly: false @@ -40969,7 +42577,7 @@ paths: application/json: schema: type: array - items: &265 + items: &269 title: Projects v2 Project description: A projects v2 project type: object @@ -41043,7 +42651,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &758 + - &763 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -41128,7 +42736,7 @@ paths: - deleted_at - deleted_by examples: - default: &266 + default: &270 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -41231,7 +42839,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-organization parameters: - - &267 + - &271 name: project_number description: The project's number. in: path @@ -41244,9 +42852,9 @@ paths: description: Response content: application/json: - schema: *265 + schema: *269 examples: - default: *266 + default: *270 headers: Link: *66 '304': *35 @@ -41269,7 +42877,7 @@ paths: url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - *74 - - *267 + - *271 requestBody: required: true description: Details of the draft item to create in the project. @@ -41303,7 +42911,7 @@ paths: description: Response content: application/json: - schema: &272 + schema: &276 title: Projects v2 Item description: An item belonging to a project type: object @@ -41317,7 +42925,7 @@ paths: content: oneOf: - *82 - - &462 + - &466 title: Pull Request Simple description: Pull Request Simple type: object @@ -41437,7 +43045,7 @@ paths: milestone: anyOf: - type: 'null' - - *268 + - *272 active_lock_reason: type: - string @@ -41486,7 +43094,7 @@ paths: items: *4 requested_teams: type: array - items: *187 + items: *191 head: type: object properties: @@ -41530,7 +43138,7 @@ paths: _links: type: object properties: - comments: &269 + comments: &273 title: Link description: Hypermedia Link type: object @@ -41539,13 +43147,13 @@ paths: type: string required: - href - commits: *269 - statuses: *269 - html: *269 - issue: *269 - review_comments: *269 - review_comment: *269 - self: *269 + commits: *273 + statuses: *273 + html: *273 + issue: *273 + review_comments: *273 + review_comment: *273 + self: *273 required: - comments - commits @@ -41556,7 +43164,7 @@ paths: - review_comment - self author_association: *79 - auto_merge: &568 + auto_merge: &572 title: Auto merge description: The status of auto merging a pull request. type: @@ -41658,7 +43266,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: &271 + content_type: &275 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -41702,7 +43310,7 @@ paths: - updated_at - archived_at examples: - draft_issue: &273 + draft_issue: &277 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -41776,7 +43384,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization parameters: - - *267 + - *271 - *74 - *17 - *45 @@ -41788,7 +43396,7 @@ paths: application/json: schema: type: array - items: &270 + items: &274 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -41941,7 +43549,7 @@ paths: - updated_at - project_url examples: - default: &694 + default: &699 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -42071,7 +43679,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project parameters: - - *267 + - *271 - *74 requestBody: required: true @@ -42118,7 +43726,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &695 + items: &700 type: object properties: name: @@ -42155,7 +43763,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &696 + iteration_configuration: &701 type: object description: The configuration for iteration fields. properties: @@ -42205,7 +43813,7 @@ paths: value: name: Due date data_type: date - single_select_field: &697 + single_select_field: &702 summary: Create a single select field value: name: Priority @@ -42232,7 +43840,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &698 + iteration_field: &703 summary: Create an iteration field value: name: Sprint @@ -42256,9 +43864,9 @@ paths: description: Response for adding a field to an organization-owned project. content: application/json: - schema: *270 + schema: *274 examples: - text_field: &699 + text_field: &704 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -42267,7 +43875,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-05-15T08:00:00Z' updated_at: '2022-05-15T08:00:00Z' - number_field: &700 + number_field: &705 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -42276,7 +43884,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-01T14:30:00Z' updated_at: '2022-06-01T14:30:00Z' - date_field: &701 + date_field: &706 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -42285,7 +43893,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-10T09:15:00Z' updated_at: '2022-06-10T09:15:00Z' - single_select_field: &702 + single_select_field: &707 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -42319,7 +43927,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &703 + iteration_field: &708 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -42364,8 +43972,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - - *267 - - &704 + - *271 + - &709 name: field_id description: The unique identifier of the field. in: path @@ -42378,9 +43986,9 @@ paths: description: Response content: application/json: - schema: *270 + schema: *274 examples: - default: &705 + default: &710 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -42436,7 +44044,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *267 + - *271 - *74 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) @@ -42469,7 +44077,7 @@ paths: application/json: schema: type: array - items: &274 + items: &278 title: Projects v2 Item description: An item belonging to a project type: object @@ -42486,7 +44094,7 @@ paths: description: The API URL of the project that contains this item. examples: - https://api.github.com/users/monalisa/2/projectsV2/3 - content_type: *271 + content_type: *275 content: type: - object @@ -42536,7 +44144,7 @@ paths: - updated_at - archived_at examples: - default: &275 + default: &279 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -43234,7 +44842,7 @@ paths: url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project parameters: - *74 - - *267 + - *271 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -43304,22 +44912,22 @@ paths: description: Response content: application/json: - schema: *272 + schema: *276 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *273 + value: *277 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *273 + value: *277 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *273 + value: *277 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *273 + value: *277 '304': *35 '403': *27 '401': *23 @@ -43339,9 +44947,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *267 + - *271 - *74 - - &276 + - &280 name: item_id description: The unique identifier of the project item. in: path @@ -43367,9 +44975,9 @@ paths: description: Response content: application/json: - schema: *274 + schema: *278 examples: - default: *275 + default: *279 headers: Link: *66 '304': *35 @@ -43390,9 +44998,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-organization parameters: - - *267 + - *271 - *74 - - *276 + - *280 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -43465,13 +45073,13 @@ paths: description: Response content: application/json: - schema: *274 + schema: *278 examples: - text_field: *275 - number_field: *275 - date_field: *275 - single_select_field: *275 - iteration_field: *275 + text_field: *279 + number_field: *279 + date_field: *279 + single_select_field: *279 + iteration_field: *279 '401': *23 '403': *27 '404': *6 @@ -43491,9 +45099,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization parameters: - - *267 + - *271 - *74 - - *276 + - *280 responses: '204': description: Response @@ -43517,7 +45125,7 @@ paths: url: https://docs.github.com/rest/projects/views#create-a-view-for-an-organization-owned-project parameters: - *74 - - *267 + - *271 requestBody: required: true content: @@ -43591,7 +45199,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &686 + schema: &690 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -43695,7 +45303,7 @@ paths: examples: table_view: summary: Response for creating a table view - value: &277 + value: &281 value: id: 1 number: 1 @@ -43741,10 +45349,10 @@ paths: - 456 board_view: summary: Response for creating a board view with filter - value: *277 + value: *281 roadmap_view: summary: Response for creating a roadmap view - value: *277 + value: *281 '304': *35 '403': *27 '401': *23 @@ -43772,9 +45380,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-project-view parameters: - - *267 + - *271 - *74 - - &706 + - &711 name: view_number description: The number that identifies the project view. in: path @@ -43806,9 +45414,9 @@ paths: application/json: schema: type: array - items: *274 + items: *278 examples: - default: *275 + default: *279 headers: Link: *66 '304': *35 @@ -43841,7 +45449,7 @@ paths: application/json: schema: type: array - items: &278 + items: &282 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -43919,7 +45527,7 @@ paths: - property_name - value_type examples: - default: &279 + default: &283 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -43979,7 +45587,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *278 + items: *282 minItems: 1 maxItems: 100 required: @@ -44009,9 +45617,9 @@ paths: application/json: schema: type: array - items: *278 + items: *282 examples: - default: *279 + default: *283 '403': *27 '404': *6 x-github: @@ -44033,7 +45641,7 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - *74 - - &280 + - &284 name: custom_property_name description: The custom property name in: path @@ -44045,9 +45653,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *282 examples: - default: &281 + default: &285 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -44082,7 +45690,7 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - *74 - - *280 + - *284 requestBody: required: true content: @@ -44162,9 +45770,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *282 examples: - default: *281 + default: *285 '403': *27 '404': *6 x-github: @@ -44188,7 +45796,7 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - *74 - - *280 + - *284 responses: '204': *59 '403': *27 @@ -44252,7 +45860,7 @@ paths: - octocat/Hello-World properties: type: array - items: &282 + items: &286 title: Custom Property Value description: Custom property name and associated value type: object @@ -44342,7 +45950,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *282 + items: *286 required: - repository_names - properties @@ -44534,7 +46142,7 @@ paths: type: array items: *153 examples: - default: *255 + default: *259 headers: Link: *66 x-github: @@ -44737,7 +46345,7 @@ paths: description: Response content: application/json: - schema: &330 + schema: &334 title: Full Repository description: Full Repository type: object @@ -45215,7 +46823,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &467 + code_of_conduct: &471 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -45245,7 +46853,7 @@ paths: - key - name - html_url - security_and_analysis: *283 + security_and_analysis: *287 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -45329,7 +46937,7 @@ paths: - network_count - subscribers_count examples: - default: &332 + default: &336 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -45850,7 +47458,7 @@ paths: - *74 - *17 - *19 - - &590 + - &594 name: targets description: | A comma-separated list of rule targets to filter by. @@ -45869,7 +47477,7 @@ paths: application/json: schema: type: array - items: &310 + items: &314 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -45904,7 +47512,7 @@ paths: source: type: string description: The name of the source - enforcement: &286 + enforcement: &290 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -45917,7 +47525,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &287 + items: &291 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -45988,7 +47596,7 @@ paths: description: The html URL of the ruleset conditions: anyOf: - - &284 + - &288 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -46012,7 +47620,7 @@ paths: match. items: type: string - - &288 + - &292 title: Organization ruleset conditions type: object description: |- @@ -46026,7 +47634,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *284 + - *288 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -46060,7 +47668,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *284 + - *288 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -46082,7 +47690,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *284 + - *288 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -46095,7 +47703,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &285 + items: &289 title: Repository ruleset property targeting definition type: object @@ -46128,7 +47736,7 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *285 + items: *289 required: - repository_property type: @@ -46136,12 +47744,12 @@ paths: - object rules: type: array - items: &591 + items: &595 title: Repository Rule type: object description: A repository rule. oneOf: - - &289 + - &293 title: creation description: Only allow users with bypass permission to create matching refs. @@ -46153,7 +47761,7 @@ paths: type: string enum: - creation - - &290 + - &294 title: update description: Only allow users with bypass permission to update matching refs. @@ -46174,7 +47782,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &291 + - &295 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -46186,7 +47794,7 @@ paths: type: string enum: - deletion - - &292 + - &296 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -46198,7 +47806,7 @@ paths: type: string enum: - required_linear_history - - &589 + - &593 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -46276,7 +47884,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &293 + - &297 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -46300,7 +47908,7 @@ paths: type: string required: - required_deployment_environments - - &294 + - &298 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -46312,7 +47920,7 @@ paths: type: string enum: - required_signatures - - &295 + - &299 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -46418,7 +48026,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &296 + - &300 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -46466,7 +48074,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &297 + - &301 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -46478,7 +48086,7 @@ paths: type: string enum: - non_fast_forward - - &298 + - &302 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -46515,7 +48123,7 @@ paths: required: - operator - pattern - - &299 + - &303 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -46552,7 +48160,7 @@ paths: required: - operator - pattern - - &300 + - &304 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -46589,7 +48197,7 @@ paths: required: - operator - pattern - - &301 + - &305 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -46626,7 +48234,7 @@ paths: required: - operator - pattern - - &302 + - &306 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -46663,7 +48271,7 @@ paths: required: - operator - pattern - - &303 + - &307 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -46688,7 +48296,7 @@ paths: type: string required: - restricted_file_paths - - &304 + - &308 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -46712,7 +48320,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &305 + - &309 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -46735,7 +48343,7 @@ paths: type: string required: - restricted_file_extensions - - &306 + - &310 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -46760,7 +48368,7 @@ paths: maximum: 100 required: - max_file_size - - &307 + - &311 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -46810,7 +48418,7 @@ paths: - repository_id required: - workflows - - &308 + - &312 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -46871,7 +48479,7 @@ paths: - tool required: - code_scanning_tools - - &309 + - &313 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -46970,24 +48578,20 @@ paths: - push - repository default: branch - enforcement: *286 + enforcement: *290 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *287 - conditions: *288 + items: *291 + conditions: *292 rules: type: array description: An array of rules within the ruleset. - items: &312 + items: &316 title: Repository Rule type: object description: A repository rule. oneOf: - - *289 - - *290 - - *291 - - *292 - *293 - *294 - *295 @@ -47005,6 +48609,10 @@ paths: - *307 - *308 - *309 + - *310 + - *311 + - *312 + - *313 required: - name - enforcement @@ -47042,9 +48650,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *314 examples: - default: &311 + default: &315 value: id: 21 name: super cool ruleset @@ -47100,7 +48708,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *74 - - &592 + - &596 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -47115,7 +48723,7 @@ paths: in: query schema: type: string - - &593 + - &597 name: time_period description: |- The time period to filter by. @@ -47131,14 +48739,14 @@ paths: - week - month default: day - - &594 + - &598 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &595 + - &599 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -47158,7 +48766,7 @@ paths: description: Response content: application/json: - schema: &596 + schema: &600 title: Rule Suites description: Response type: array @@ -47214,7 +48822,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &597 + default: &601 value: - id: 21 actor_id: 12 @@ -47258,7 +48866,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *74 - - &598 + - &602 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -47274,7 +48882,7 @@ paths: description: Response content: application/json: - schema: &599 + schema: &603 title: Rule Suite description: Response type: object @@ -47381,7 +48989,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &600 + default: &604 value: id: 21 actor_id: 12 @@ -47454,9 +49062,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *314 examples: - default: *311 + default: *315 '404': *6 '500': *53 put: @@ -47500,16 +49108,16 @@ paths: - tag - push - repository - enforcement: *286 + enforcement: *290 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *287 - conditions: *288 + items: *291 + conditions: *292 rules: description: An array of rules within the ruleset. type: array - items: *312 + items: *316 examples: default: value: @@ -47544,9 +49152,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *314 examples: - default: *311 + default: *315 '404': *6 '422': *15 '500': *53 @@ -47604,7 +49212,7 @@ paths: application/json: schema: type: array - items: &313 + items: &317 title: Ruleset version type: object description: The historical version of a ruleset @@ -47628,7 +49236,7 @@ paths: type: string format: date-time examples: - default: &602 + default: &606 value: - version_id: 3 actor: @@ -47681,9 +49289,9 @@ paths: description: Response content: application/json: - schema: &603 + schema: &607 allOf: - - *313 + - *317 - type: object required: - state @@ -47753,7 +49361,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *74 - - &604 + - &608 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -47764,7 +49372,7 @@ paths: enum: - open - resolved - - &605 + - &609 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -47774,7 +49382,7 @@ paths: required: false schema: type: string - - &606 + - &610 name: exclude_secret_types in: query description: A comma-separated list of secret types to exclude from the results. @@ -47785,7 +49393,7 @@ paths: required: false schema: type: string - - &607 + - &611 name: exclude_providers in: query description: |- @@ -47796,7 +49404,7 @@ paths: required: false schema: type: string - - &608 + - &612 name: providers in: query description: |- @@ -47807,7 +49415,7 @@ paths: required: false schema: type: string - - &609 + - &613 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -47816,7 +49424,7 @@ paths: required: false schema: type: string - - &610 + - &614 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -47835,7 +49443,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &611 + - &615 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -47850,7 +49458,7 @@ paths: - *60 - *19 - *17 - - &612 + - &616 name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -47860,7 +49468,7 @@ paths: required: false schema: type: string - - &613 + - &617 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -47870,7 +49478,7 @@ paths: required: false schema: type: string - - &614 + - &618 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -47879,7 +49487,7 @@ paths: required: false schema: type: string - - &615 + - &619 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -47888,7 +49496,7 @@ paths: schema: type: boolean default: false - - &616 + - &620 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -47897,7 +49505,7 @@ paths: schema: type: boolean default: false - - &617 + - &621 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -47929,14 +49537,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &618 + state: &622 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &619 + resolution: &623 type: - string - 'null' @@ -48055,14 +49663,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &620 + - &624 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &622 + - &626 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -48126,7 +49734,7 @@ paths: - blob_url - commit_sha - commit_url - - &623 + - &627 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -48187,7 +49795,7 @@ paths: - page_url - commit_sha - commit_url - - &624 + - &628 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -48209,7 +49817,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &625 + - &629 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -48231,7 +49839,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &626 + - &630 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -48253,7 +49861,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &627 + - &631 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -48268,7 +49876,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &628 + - &632 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -48283,7 +49891,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &629 + - &633 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -48298,7 +49906,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &630 + - &634 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -48320,7 +49928,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &631 + - &635 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -48342,7 +49950,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &632 + - &636 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -48364,7 +49972,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &633 + - &637 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -48386,7 +49994,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &634 + - &638 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull @@ -48647,7 +50255,7 @@ paths: related to push protection. type: object properties: - pattern_config_version: &315 + pattern_config_version: &319 type: - string - 'null' @@ -48657,7 +50265,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &314 + items: &318 type: object properties: token_type: @@ -48726,7 +50334,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *314 + items: *318 examples: default: value: @@ -48783,7 +50391,7 @@ paths: schema: type: object properties: - pattern_config_version: *315 + pattern_config_version: *319 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -48809,7 +50417,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *315 + custom_pattern_version: *319 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -48907,7 +50515,7 @@ paths: application/json: schema: type: array - items: &638 + items: &642 description: A repository security advisory. type: object properties: @@ -49151,7 +50759,7 @@ paths: login: type: string description: The username of the user credited. - type: *316 + type: *320 credits_detailed: type: - array @@ -49162,7 +50770,7 @@ paths: type: object properties: user: *4 - type: *316 + type: *320 state: type: string description: The state of the user's acceptance of the @@ -49188,7 +50796,7 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *187 + items: *191 private_fork: readOnly: true description: A temporary private fork of the advisory's repository @@ -49226,7 +50834,7 @@ paths: - private_fork additionalProperties: false examples: - default: &639 + default: &643 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -49613,7 +51221,7 @@ paths: application/json: schema: type: array - items: *247 + items: *251 examples: default: value: @@ -49968,7 +51576,7 @@ paths: type: integer network_configurations: type: array - items: &317 + items: &321 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -50121,9 +51729,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *321 examples: - default: &318 + default: &322 value: id: 123456789ABCDEF name: My network configuration @@ -50152,7 +51760,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - *74 - - &319 + - &323 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -50164,9 +51772,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *321 examples: - default: *318 + default: *322 headers: Link: *66 x-github: @@ -50188,7 +51796,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - *74 - - *319 + - *323 requestBody: required: true content: @@ -50241,9 +51849,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *321 examples: - default: *318 + default: *322 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50263,7 +51871,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - *74 - - *319 + - *323 responses: '204': description: Response @@ -50408,13 +52016,13 @@ paths: application/json: schema: type: array - items: *320 + items: *324 examples: - default: *321 + default: *325 '500': *53 '403': *27 '404': *6 - '422': *322 + '422': *326 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50454,9 +52062,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - default: *248 + default: *252 headers: Link: *66 '403': *27 @@ -50550,7 +52158,7 @@ paths: description: Response content: application/json: - schema: &323 + schema: &327 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -50624,7 +52232,7 @@ paths: parent: anyOf: - type: 'null' - - *247 + - *251 members_count: type: integer examples: @@ -50949,7 +52557,7 @@ paths: - repos_count - organization examples: - default: &324 + default: &328 value: id: 1 node_id: MDQ6VGVhbTE= @@ -51026,9 +52634,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '404': *6 x-github: githubCloudOnly: false @@ -51113,16 +52721,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '201': description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '404': *6 '422': *15 '403': *27 @@ -51152,7 +52760,7 @@ paths: responses: '204': description: Response - '422': &325 + '422': &329 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -51186,12 +52794,12 @@ paths: application/json: schema: type: array - items: *226 + items: *230 examples: - default: *227 + default: *231 headers: Link: *66 - '422': *325 + '422': *329 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51273,7 +52881,7 @@ paths: description: Response content: application/json: - schema: &326 + schema: &330 title: Team Membership description: Team Membership type: object @@ -51301,7 +52909,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &654 + response-if-user-is-a-team-maintainer: &658 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -51364,9 +52972,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *330 examples: - response-if-users-membership-with-team-is-now-pending: &655 + response-if-users-membership-with-team-is-now-pending: &659 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -51442,7 +53050,7 @@ paths: type: array items: *153 examples: - default: *255 + default: *259 headers: Link: *66 x-github: @@ -51473,14 +53081,14 @@ paths: parameters: - *74 - *76 - - *327 - - *328 + - *331 + - *332 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &656 + schema: &660 title: Team Repository description: A team's access to a repository. type: object @@ -52123,8 +53731,8 @@ paths: parameters: - *74 - *76 - - *327 - - *328 + - *331 + - *332 requestBody: required: false content: @@ -52171,8 +53779,8 @@ paths: parameters: - *74 - *76 - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -52207,9 +53815,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - response-if-child-teams-exist: &657 + response-if-child-teams-exist: &661 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -52363,7 +53971,7 @@ paths: resources: type: object properties: - core: &329 + core: &333 title: Rate Limit type: object properties: @@ -52380,21 +53988,21 @@ paths: - remaining - reset - used - graphql: *329 - search: *329 - code_search: *329 - source_import: *329 - integration_manifest: *329 - code_scanning_upload: *329 - actions_runner_registration: *329 - scim: *329 - dependency_snapshots: *329 - dependency_sbom: *329 - code_scanning_autofix: *329 + graphql: *333 + search: *333 + code_search: *333 + source_import: *333 + integration_manifest: *333 + code_scanning_upload: *333 + actions_runner_registration: *333 + scim: *333 + dependency_snapshots: *333 + dependency_sbom: *333 + code_scanning_autofix: *333 required: - core - search - rate: *329 + rate: *333 required: - rate - resources @@ -52499,14 +54107,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *330 + schema: *334 examples: default-response: summary: Default response @@ -53011,7 +54619,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *331 + '301': *335 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53029,8 +54637,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: false content: @@ -53329,10 +54937,10 @@ paths: description: Response content: application/json: - schema: *330 + schema: *334 examples: - default: *332 - '307': &333 + default: *336 + '307': &337 description: Temporary Redirect content: application/json: @@ -53361,8 +54969,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -53384,7 +54992,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *333 + '307': *337 '404': *6 '409': *52 x-github: @@ -53408,11 +55016,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 - - &366 + - &370 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -53435,7 +55043,7 @@ paths: type: integer artifacts: type: array - items: &334 + items: &338 title: Artifact description: An artifact type: object @@ -53530,7 +55138,7 @@ paths: - expires_at - updated_at examples: - default: &367 + default: &371 value: total_count: 2 artifacts: @@ -53591,9 +55199,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *327 - - *328 - - &335 + - *331 + - *332 + - &339 name: artifact_id description: The unique identifier of the artifact. in: path @@ -53605,7 +55213,7 @@ paths: description: Response content: application/json: - schema: *334 + schema: *338 examples: default: value: @@ -53643,9 +55251,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *327 - - *328 - - *335 + - *331 + - *332 + - *339 responses: '204': description: Response @@ -53669,9 +55277,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *327 - - *328 - - *335 + - *331 + - *332 + - *339 - name: archive_format in: path required: true @@ -53681,11 +55289,11 @@ paths: '302': description: Response headers: - Location: &484 + Location: &488 example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': &525 + '410': &529 description: Gone content: application/json: @@ -53710,14 +55318,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: &336 + schema: &340 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -53751,13 +55359,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: application/json: - schema: *336 + schema: *340 examples: selected_actions: *40 responses: @@ -53786,14 +55394,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: &337 + schema: &341 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -53827,13 +55435,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: application/json: - schema: *337 + schema: *341 examples: selected_actions: *42 responses: @@ -53864,14 +55472,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *338 + schema: *342 examples: default: value: @@ -53897,11 +55505,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 - - &339 + - &343 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -53935,7 +55543,7 @@ paths: description: Response content: application/json: - schema: &340 + schema: &344 title: Repository actions caches description: Repository actions caches type: object @@ -53985,7 +55593,7 @@ paths: - total_count - actions_caches examples: - default: &341 + default: &345 value: total_count: 1 actions_caches: @@ -54017,23 +55625,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *327 - - *328 + - *331 + - *332 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *339 + - *343 responses: '200': description: Response content: application/json: - schema: *340 + schema: *344 examples: - default: *341 + default: *345 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54053,8 +55661,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *327 - - *328 + - *331 + - *332 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -54085,9 +55693,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *327 - - *328 - - &342 + - *331 + - *332 + - &346 name: job_id description: The unique identifier of the job. in: path @@ -54099,7 +55707,7 @@ paths: description: Response content: application/json: - schema: &370 + schema: &374 title: Job description: Information of a job execution in a workflow run type: object @@ -54446,9 +56054,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *327 - - *328 - - *342 + - *331 + - *332 + - *346 responses: '302': description: Response @@ -54476,9 +56084,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *327 - - *328 - - *342 + - *331 + - *332 + - *346 requestBody: required: false content: @@ -54524,8 +56132,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Status response @@ -54546,6 +56154,15 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether the repository has opted in to the immutable + OIDC subject claim format. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. If not set at the + repository level, falls back to the organization-level setting. + type: boolean + sub_claim_prefix: + description: The current `sub` claim prefix for this repository. + type: string required: - use_default examples: @@ -54575,8 +56192,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -54598,6 +56215,11 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for this repository. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. + type: boolean examples: default: value: @@ -54639,8 +56261,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -54658,7 +56280,7 @@ paths: type: integer secrets: type: array - items: &372 + items: &376 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -54679,7 +56301,7 @@ paths: - created_at - updated_at examples: - default: &373 + default: &377 value: total_count: 2 secrets: @@ -54712,9 +56334,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *327 - - *328 - - *343 + - *331 + - *332 + - *347 - *19 responses: '200': @@ -54731,7 +56353,7 @@ paths: type: integer variables: type: array - items: &376 + items: &380 title: Actions Variable type: object properties: @@ -54765,7 +56387,7 @@ paths: - created_at - updated_at examples: - default: &377 + default: &381 value: total_count: 2 variables: @@ -54798,8 +56420,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -54808,11 +56430,11 @@ paths: schema: type: object properties: - enabled: &345 + enabled: &349 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *138 - selected_actions_url: *344 + selected_actions_url: *348 sha_pinning_required: *139 required: - enabled @@ -54841,8 +56463,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -54853,7 +56475,7 @@ paths: schema: type: object properties: - enabled: *345 + enabled: *349 allowed_actions: *138 sha_pinning_required: *139 required: @@ -54885,14 +56507,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: &346 + schema: &350 type: object properties: access_level: @@ -54909,7 +56531,7 @@ paths: required: - access_level examples: - default: &347 + default: &351 value: access_level: organization x-github: @@ -54933,15 +56555,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: application/json: - schema: *346 + schema: *350 examples: - default: *347 + default: *351 responses: '204': description: Response @@ -54965,14 +56587,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *348 + schema: *352 examples: default: value: @@ -54996,8 +56618,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Empty response for successful settings update @@ -55007,7 +56629,7 @@ paths: required: true content: application/json: - schema: *349 + schema: *353 examples: default: summary: Set retention days @@ -55031,8 +56653,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -55040,7 +56662,7 @@ paths: application/json: schema: *140 examples: - default: *350 + default: *354 '404': *6 x-github: enabledForGitHubApps: true @@ -55059,8 +56681,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -55094,14 +56716,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *351 + schema: *355 examples: default: *141 '403': *27 @@ -55123,13 +56745,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: application/json: - schema: *352 + schema: *356 examples: default: *141 responses: @@ -55155,8 +56777,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -55183,8 +56805,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -55216,14 +56838,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *353 + schema: *357 examples: default: *148 x-github: @@ -55246,8 +56868,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Success response @@ -55258,7 +56880,7 @@ paths: required: true content: application/json: - schema: *354 + schema: *358 examples: default: *148 x-github: @@ -55287,8 +56909,8 @@ paths: in: query schema: type: string - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -55332,8 +56954,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -55341,9 +56963,9 @@ paths: application/json: schema: type: array - items: *355 + items: *359 examples: - default: *356 + default: *360 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55365,8 +56987,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -55409,7 +57031,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *357 + '201': *361 '404': *6 '422': *7 '409': *52 @@ -55440,8 +57062,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '201': description: Response @@ -55449,7 +57071,7 @@ paths: application/json: schema: *157 examples: - default: *358 + default: *362 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55477,8 +57099,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '201': description: Response @@ -55486,7 +57108,7 @@ paths: application/json: schema: *157 examples: - default: *359 + default: *363 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55508,8 +57130,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *154 responses: '200': @@ -55518,7 +57140,7 @@ paths: application/json: schema: *155 examples: - default: *360 + default: *364 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55539,8 +57161,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *154 responses: '204': @@ -55567,8 +57189,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *154 responses: '200': *159 @@ -55593,8 +57215,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *154 requestBody: required: true @@ -55643,8 +57265,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *154 requestBody: required: true @@ -55694,11 +57316,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *154 responses: - '200': *361 + '200': *365 '404': *6 x-github: githubCloudOnly: false @@ -55725,10 +57347,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *154 - - *362 + - *366 responses: '200': *159 '404': *6 @@ -55756,9 +57378,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *327 - - *328 - - &380 + - *331 + - *332 + - &384 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -55766,7 +57388,7 @@ paths: required: false schema: type: string - - &381 + - &385 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -55774,7 +57396,7 @@ paths: required: false schema: type: string - - &382 + - &386 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -55783,7 +57405,7 @@ paths: required: false schema: type: string - - &383 + - &387 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -55810,7 +57432,7 @@ paths: - pending - *17 - *19 - - &384 + - &388 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -55819,7 +57441,7 @@ paths: schema: type: string format: date-time - - &363 + - &367 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -55828,13 +57450,13 @@ paths: schema: type: boolean default: false - - &385 + - &389 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &386 + - &390 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -55857,7 +57479,7 @@ paths: type: integer workflow_runs: type: array - items: &364 + items: &368 title: Workflow Run description: An invocation of a workflow type: object @@ -56035,7 +57657,7 @@ paths: head_commit: anyOf: - type: 'null' - - &408 + - &412 title: Simple Commit description: A commit. type: object @@ -56150,7 +57772,7 @@ paths: - workflow_url - pull_requests examples: - default: &387 + default: &391 value: total_count: 1 workflow_runs: @@ -56386,24 +58008,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *327 - - *328 - - &365 + - *331 + - *332 + - &369 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *363 + - *367 responses: '200': description: Response content: application/json: - schema: *364 + schema: *368 examples: - default: &368 + default: &372 value: id: 30433642 name: Build @@ -56644,9 +58266,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '204': description: Response @@ -56669,9 +58291,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '200': description: Response @@ -56799,9 +58421,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '201': description: Response @@ -56834,12 +58456,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 - *17 - *19 - - *366 + - *370 - *60 responses: '200': @@ -56856,9 +58478,9 @@ paths: type: integer artifacts: type: array - items: *334 + items: *338 examples: - default: *367 + default: *371 headers: Link: *66 x-github: @@ -56882,25 +58504,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *327 - - *328 - - *365 - - &369 + - *331 + - *332 + - *369 + - &373 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *363 + - *367 responses: '200': description: Response content: application/json: - schema: *364 + schema: *368 examples: - default: *368 + default: *372 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56923,10 +58545,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *327 - - *328 - - *365 + - *331 + - *332 - *369 + - *373 - *17 - *19 responses: @@ -56944,9 +58566,9 @@ paths: type: integer jobs: type: array - items: *370 + items: *374 examples: - default: &371 + default: &375 value: total_count: 1 jobs: @@ -57059,10 +58681,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *327 - - *328 - - *365 + - *331 + - *332 - *369 + - *373 responses: '302': description: Response @@ -57090,9 +58712,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '202': description: Response @@ -57125,9 +58747,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 requestBody: required: true content: @@ -57194,9 +58816,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '202': description: Response @@ -57229,9 +58851,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -57261,9 +58883,9 @@ paths: type: integer jobs: type: array - items: *370 + items: *374 examples: - default: *371 + default: *375 headers: Link: *66 x-github: @@ -57288,9 +58910,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '302': description: Response @@ -57317,9 +58939,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '204': description: Response @@ -57346,9 +58968,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '200': description: Response @@ -57417,7 +59039,7 @@ paths: items: type: object properties: - type: &491 + type: &495 type: string description: The type of reviewer. enum: @@ -57428,7 +59050,7 @@ paths: reviewer: anyOf: - *4 - - *187 + - *191 required: - environment - wait_timer @@ -57503,9 +59125,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 requestBody: required: true content: @@ -57555,7 +59177,7 @@ paths: application/json: schema: type: array - items: &486 + items: &490 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -57667,7 +59289,7 @@ paths: - created_at - updated_at examples: - default: &487 + default: &491 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -57723,9 +59345,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 requestBody: required: false content: @@ -57770,9 +59392,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 requestBody: required: false content: @@ -57826,9 +59448,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '200': description: Response @@ -57965,8 +59587,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -57984,9 +59606,9 @@ paths: type: integer secrets: type: array - items: *372 + items: *376 examples: - default: *373 + default: *377 headers: Link: *66 x-github: @@ -58011,16 +59633,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *374 + schema: *378 examples: - default: *375 + default: *379 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58042,17 +59664,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 responses: '200': description: Response content: application/json: - schema: *372 + schema: *376 examples: - default: &504 + default: &508 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -58078,8 +59700,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 requestBody: required: true @@ -58137,8 +59759,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 responses: '204': @@ -58164,9 +59786,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *327 - - *328 - - *343 + - *331 + - *332 + - *347 - *19 responses: '200': @@ -58183,9 +59805,9 @@ paths: type: integer variables: type: array - items: *376 + items: *380 examples: - default: *377 + default: *381 headers: Link: *66 x-github: @@ -58208,8 +59830,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -58261,17 +59883,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *327 - - *328 + - *331 + - *332 - *164 responses: '200': description: Response content: application/json: - schema: *376 + schema: *380 examples: - default: &505 + default: &509 value: name: USERNAME value: octocat @@ -58297,8 +59919,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *327 - - *328 + - *331 + - *332 - *164 requestBody: required: true @@ -58341,8 +59963,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *327 - - *328 + - *331 + - *332 - *164 responses: '204': @@ -58368,8 +59990,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -58387,7 +60009,7 @@ paths: type: integer workflows: type: array - items: &378 + items: &382 title: Workflow description: A GitHub Actions workflow type: object @@ -58505,9 +60127,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *327 - - *328 - - &379 + - *331 + - *332 + - &383 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -58522,7 +60144,7 @@ paths: description: Response content: application/json: - schema: *378 + schema: *382 examples: default: value: @@ -58555,9 +60177,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *327 - - *328 - - *379 + - *331 + - *332 + - *383 responses: '204': description: Response @@ -58582,9 +60204,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *327 - - *328 - - *379 + - *331 + - *332 + - *383 responses: '204': description: Empty response when `return_run_details` parameter is `false`. @@ -58671,9 +60293,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *327 - - *328 - - *379 + - *331 + - *332 + - *383 responses: '204': description: Response @@ -58700,19 +60322,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *327 - - *328 - - *379 - - *380 - - *381 - - *382 + - *331 + - *332 - *383 - - *17 - - *19 - *384 - - *363 - *385 - *386 + - *387 + - *17 + - *19 + - *388 + - *367 + - *389 + - *390 responses: '200': description: Response @@ -58728,9 +60350,9 @@ paths: type: integer workflow_runs: type: array - items: *364 + items: *368 examples: - default: *387 + default: *391 headers: Link: *66 x-github: @@ -58762,9 +60384,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *327 - - *328 - - *379 + - *331 + - *332 + - *383 responses: '200': description: Response @@ -58825,8 +60447,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *327 - - *328 + - *331 + - *332 - *60 - *17 - *45 @@ -58994,8 +60616,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -59032,8 +60654,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *327 - - *328 + - *331 + - *332 - name: assignee in: path required: true @@ -59069,8 +60691,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#create-an-attestation parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -59180,8 +60802,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#list-attestations parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *45 - *46 @@ -59238,7 +60860,7 @@ paths: initiator: type: string examples: - default: *388 + default: *392 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59258,8 +60880,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -59267,7 +60889,7 @@ paths: application/json: schema: type: array - items: &389 + items: &393 title: Autolink reference description: An autolink reference. type: object @@ -59326,8 +60948,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -59366,9 +60988,9 @@ paths: description: response content: application/json: - schema: *389 + schema: *393 examples: - default: &390 + default: &394 value: id: 1 key_prefix: TICKET- @@ -59399,9 +61021,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *327 - - *328 - - &391 + - *331 + - *332 + - &395 name: autolink_id description: The unique identifier of the autolink. in: path @@ -59413,9 +61035,9 @@ paths: description: Response content: application/json: - schema: *389 + schema: *393 examples: - default: *390 + default: *394 '404': *6 x-github: githubCloudOnly: false @@ -59435,9 +61057,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *327 - - *328 - - *391 + - *331 + - *332 + - *395 responses: '204': description: Response @@ -59461,8 +61083,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response if Dependabot is enabled @@ -59512,8 +61134,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -59534,8 +61156,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -59555,8 +61177,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *327 - - *328 + - *331 + - *332 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -59594,7 +61216,7 @@ paths: - url protected: type: boolean - protection: &393 + protection: &397 title: Branch Protection description: Branch Protection type: object @@ -59637,7 +61259,7 @@ paths: required: - contexts - checks - enforce_admins: &396 + enforce_admins: &400 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -59654,7 +61276,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &398 + required_pull_request_reviews: &402 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -59676,7 +61298,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *187 + items: *191 apps: description: The list of apps with review dismissal access. @@ -59708,7 +61330,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *187 + items: *191 apps: description: The list of apps allowed to bypass pull request requirements. @@ -59738,7 +61360,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &395 + restrictions: &399 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -59801,7 +61423,7 @@ paths: type: string teams: type: array - items: *187 + items: *191 apps: type: array items: @@ -60031,9 +61653,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *327 - - *328 - - &394 + - *331 + - *332 + - &398 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). @@ -60047,14 +61669,14 @@ paths: description: Response content: application/json: - schema: &404 + schema: &408 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &458 + commit: &462 title: Commit description: Commit type: object @@ -60093,7 +61715,7 @@ paths: author: anyOf: - type: 'null' - - &392 + - &396 title: Git User description: Metaproperties for Git author/committer information. @@ -60115,7 +61737,7 @@ paths: committer: anyOf: - type: 'null' - - *392 + - *396 message: type: string examples: @@ -60139,7 +61761,7 @@ paths: required: - sha - url - verification: &511 + verification: &515 title: Verification type: object properties: @@ -60219,7 +61841,7 @@ paths: type: integer files: type: array - items: &469 + items: &473 title: Diff Entry description: Diff Entry type: object @@ -60315,7 +61937,7 @@ paths: - self protected: type: boolean - protection: *393 + protection: *397 protection_url: type: string format: uri @@ -60424,7 +62046,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *331 + '301': *335 '404': *6 x-github: githubCloudOnly: false @@ -60446,15 +62068,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *393 + schema: *397 examples: default: value: @@ -60648,9 +62270,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -60910,7 +62532,7 @@ paths: url: type: string format: uri - required_status_checks: &401 + required_status_checks: &405 title: Status Check Policy description: Status Check Policy type: object @@ -60991,7 +62613,7 @@ paths: items: *4 teams: type: array - items: *187 + items: *191 apps: type: array items: *5 @@ -61009,7 +62631,7 @@ paths: items: *4 teams: type: array - items: *187 + items: *191 apps: type: array items: *5 @@ -61069,7 +62691,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *395 + restrictions: *399 required_conversation_resolution: type: object properties: @@ -61181,9 +62803,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '204': description: Response @@ -61208,17 +62830,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *396 + schema: *400 examples: - default: &397 + default: &401 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -61240,17 +62862,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *396 + schema: *400 examples: - default: *397 + default: *401 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61269,9 +62891,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '204': description: Response @@ -61296,17 +62918,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *398 + schema: *402 examples: - default: &399 + default: &403 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -61402,9 +63024,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: false content: @@ -61502,9 +63124,9 @@ paths: description: Response content: application/json: - schema: *398 + schema: *402 examples: - default: *399 + default: *403 '422': *15 x-github: githubCloudOnly: false @@ -61525,9 +63147,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '204': description: Response @@ -61554,17 +63176,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *396 + schema: *400 examples: - default: &400 + default: &404 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -61587,17 +63209,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *396 + schema: *400 examples: - default: *400 + default: *404 '404': *6 x-github: githubCloudOnly: false @@ -61617,9 +63239,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '204': description: Response @@ -61644,17 +63266,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *401 + schema: *405 examples: - default: &402 + default: &406 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -61680,9 +63302,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: false content: @@ -61734,9 +63356,9 @@ paths: description: Response content: application/json: - schema: *401 + schema: *405 examples: - default: *402 + default: *406 '404': *6 '422': *15 x-github: @@ -61758,9 +63380,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '204': description: Response @@ -61784,9 +63406,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response @@ -61820,9 +63442,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: false content: @@ -61889,9 +63511,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: false content: @@ -61955,9 +63577,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: content: application/json: @@ -62023,15 +63645,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *395 + schema: *399 examples: default: value: @@ -62122,9 +63744,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '204': description: Response @@ -62147,9 +63769,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response @@ -62159,7 +63781,7 @@ paths: type: array items: *5 examples: - default: &403 + default: &407 value: - id: 1 slug: octoapp @@ -62216,9 +63838,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -62252,7 +63874,7 @@ paths: type: array items: *5 examples: - default: *403 + default: *407 '422': *15 x-github: githubCloudOnly: false @@ -62273,9 +63895,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -62309,7 +63931,7 @@ paths: type: array items: *5 examples: - default: *403 + default: *407 '422': *15 x-github: githubCloudOnly: false @@ -62330,9 +63952,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -62366,7 +63988,7 @@ paths: type: array items: *5 examples: - default: *403 + default: *407 '422': *15 x-github: githubCloudOnly: false @@ -62388,9 +64010,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response @@ -62398,9 +64020,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - default: *248 + default: *252 '404': *6 x-github: githubCloudOnly: false @@ -62420,9 +64042,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: false content: @@ -62458,9 +64080,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - default: *248 + default: *252 '422': *15 x-github: githubCloudOnly: false @@ -62481,9 +64103,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: false content: @@ -62519,9 +64141,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - default: *248 + default: *252 '422': *15 x-github: githubCloudOnly: false @@ -62542,9 +64164,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: content: application/json: @@ -62579,9 +64201,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - default: *248 + default: *252 '422': *15 x-github: githubCloudOnly: false @@ -62603,9 +64225,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response @@ -62639,9 +64261,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -62699,9 +64321,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -62759,9 +64381,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -62821,9 +64443,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -62845,7 +64467,7 @@ paths: description: Response content: application/json: - schema: *404 + schema: *408 examples: default: value: @@ -62961,8 +64583,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -63241,7 +64863,7 @@ paths: description: Response content: application/json: - schema: &405 + schema: &409 title: CheckRun description: A check performed on the code of a given code change type: object @@ -63377,7 +64999,7 @@ paths: check. type: array items: *85 - deployment: &719 + deployment: &724 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -63664,9 +65286,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *327 - - *328 - - &406 + - *331 + - *332 + - &410 name: check_run_id description: The unique identifier of the check run. in: path @@ -63678,9 +65300,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *409 examples: - default: &407 + default: &411 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -63780,9 +65402,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *327 - - *328 - - *406 + - *331 + - *332 + - *410 requestBody: required: true content: @@ -64022,9 +65644,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *409 examples: - default: *407 + default: *411 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64044,9 +65666,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *327 - - *328 - - *406 + - *331 + - *332 + - *410 - *17 - *19 responses: @@ -64156,9 +65778,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *327 - - *328 - - *406 + - *331 + - *332 + - *410 responses: '201': description: Response @@ -64202,8 +65824,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -64225,7 +65847,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &409 + schema: &413 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -64323,7 +65945,7 @@ paths: - string - 'null' format: date-time - head_commit: *408 + head_commit: *412 latest_check_runs_count: type: integer check_runs_url: @@ -64351,7 +65973,7 @@ paths: - check_runs_url - pull_requests examples: - default: &410 + default: &414 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -64642,9 +66264,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *409 + schema: *413 examples: - default: *410 + default: *414 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64663,8 +66285,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -64973,9 +66595,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *327 - - *328 - - &411 + - *331 + - *332 + - &415 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -64987,9 +66609,9 @@ paths: description: Response content: application/json: - schema: *409 + schema: *413 examples: - default: *410 + default: *414 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65012,17 +66634,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *327 - - *328 - - *411 - - &464 + - *331 + - *332 + - *415 + - &468 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &465 + - &469 name: status description: Returns check runs with the specified `status`. in: query @@ -65061,9 +66683,9 @@ paths: type: integer check_runs: type: array - items: *405 + items: *409 examples: - default: &466 + default: &470 value: total_count: 1 check_runs: @@ -65165,9 +66787,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *327 - - *328 - - *411 + - *331 + - *332 + - *415 responses: '201': description: Response @@ -65200,21 +66822,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *327 - - *328 - - *412 - - *413 + - *331 + - *332 + - *416 + - *417 - *19 - *17 - - &430 + - &434 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *414 - - &431 + schema: *418 + - &435 name: pr description: The number of the pull request for the results you want to list. in: query @@ -65239,13 +66861,13 @@ paths: be returned. in: query required: false - schema: *415 + schema: *419 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *416 + schema: *420 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -65269,7 +66891,7 @@ paths: updated_at: *173 url: *174 html_url: *175 - instances_url: *417 + instances_url: *421 state: *180 fixed_at: *176 dismissed_by: @@ -65277,11 +66899,11 @@ paths: - type: 'null' - *4 dismissed_at: *177 - dismissed_reason: *418 - dismissed_comment: *419 - rule: *420 - tool: *421 - most_recent_instance: *422 + dismissed_reason: *422 + dismissed_comment: *423 + rule: *424 + tool: *425 + most_recent_instance: *426 dismissal_approved_by: anyOf: - type: 'null' @@ -65404,7 +67026,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &423 + '403': &427 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -65431,9 +67053,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *327 - - *328 - - &424 + - *331 + - *332 + - &428 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -65447,7 +67069,7 @@ paths: description: Response content: application/json: - schema: &425 + schema: &429 type: object properties: number: *171 @@ -65455,7 +67077,7 @@ paths: updated_at: *173 url: *174 html_url: *175 - instances_url: *417 + instances_url: *421 state: *180 fixed_at: *176 dismissed_by: @@ -65463,8 +67085,8 @@ paths: - type: 'null' - *4 dismissed_at: *177 - dismissed_reason: *418 - dismissed_comment: *419 + dismissed_reason: *422 + dismissed_comment: *423 rule: type: object properties: @@ -65526,8 +67148,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *421 - most_recent_instance: *422 + tool: *425 + most_recent_instance: *426 dismissal_approved_by: anyOf: - type: 'null' @@ -65623,7 +67245,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *423 + '403': *427 '404': *6 '503': *114 x-github: @@ -65643,9 +67265,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *327 - - *328 - - *424 + - *331 + - *332 + - *428 requestBody: required: true content: @@ -65660,8 +67282,8 @@ paths: enum: - open - dismissed - dismissed_reason: *418 - dismissed_comment: *419 + dismissed_reason: *422 + dismissed_comment: *423 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -65689,7 +67311,7 @@ paths: description: Response content: application/json: - schema: *425 + schema: *429 examples: default: value: @@ -65765,7 +67387,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &429 + '403': &433 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -65792,15 +67414,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *327 - - *328 - - *424 + - *331 + - *332 + - *428 responses: '200': description: Response content: application/json: - schema: &426 + schema: &430 type: object properties: status: @@ -65827,13 +67449,13 @@ paths: - description - started_at examples: - default: &427 + default: &431 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &428 + '400': &432 description: Bad Request content: application/json: @@ -65844,7 +67466,7 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *423 + '403': *427 '404': *6 '503': *114 x-github: @@ -65869,29 +67491,29 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *327 - - *328 - - *424 + - *331 + - *332 + - *428 responses: '200': description: OK content: application/json: - schema: *426 + schema: *430 examples: - default: *427 + default: *431 '202': description: Accepted content: application/json: - schema: *426 + schema: *430 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *428 + '400': *432 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -65923,9 +67545,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *327 - - *328 - - *424 + - *331 + - *332 + - *428 requestBody: required: false content: @@ -65971,8 +67593,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *428 - '403': *429 + '400': *432 + '403': *433 '404': *6 '422': description: Unprocessable Entity @@ -65996,13 +67618,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *327 - - *328 - - *424 + - *331 + - *332 + - *428 - *19 - *17 - - *430 - - *431 + - *434 + - *435 responses: '200': description: Response @@ -66013,10 +67635,10 @@ paths: items: type: object properties: - ref: *414 - analysis_key: *432 - environment: *433 - category: *434 + ref: *418 + analysis_key: *436 + environment: *437 + category: *438 state: type: - string @@ -66033,7 +67655,7 @@ paths: properties: text: type: string - location: *435 + location: *439 html_url: type: string classifications: @@ -66041,7 +67663,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: *436 + items: *440 examples: default: value: @@ -66078,7 +67700,7 @@ paths: end_column: 50 classifications: - source - '403': *423 + '403': *427 '404': *6 '503': *114 x-github: @@ -66112,25 +67734,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *327 - - *328 - - *412 - - *413 + - *331 + - *332 + - *416 + - *417 - *19 - *17 - - *431 + - *435 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *414 + schema: *418 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &437 + schema: &441 type: string description: An identifier for the upload. examples: @@ -66152,23 +67774,23 @@ paths: application/json: schema: type: array - items: &438 + items: &442 type: object properties: - ref: *414 - commit_sha: &446 + ref: *418 + commit_sha: &450 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *432 + analysis_key: *436 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *434 + category: *438 error: type: string examples: @@ -66193,8 +67815,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *437 - tool: *421 + sarif_id: *441 + tool: *425 deletable: type: boolean warning: @@ -66256,7 +67878,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *423 + '403': *427 '404': *6 '503': *114 x-github: @@ -66292,8 +67914,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -66306,7 +67928,7 @@ paths: description: Response content: application/json: - schema: *438 + schema: *442 examples: response: summary: application/json response @@ -66360,7 +67982,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *423 + '403': *427 '404': *6 '422': description: Response if analysis could not be processed @@ -66447,8 +68069,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -66504,7 +68126,7 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *429 + '403': *433 '404': *6 '503': *114 x-github: @@ -66526,8 +68148,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -66535,7 +68157,7 @@ paths: application/json: schema: type: array - items: &439 + items: &443 title: CodeQL Database description: A CodeQL database. type: object @@ -66647,7 +68269,7 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *423 + '403': *427 '404': *6 '503': *114 x-github: @@ -66676,8 +68298,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - name: language in: path description: The language of the CodeQL database. @@ -66689,7 +68311,7 @@ paths: description: Response content: application/json: - schema: *439 + schema: *443 examples: default: value: @@ -66721,9 +68343,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &473 + '302': &477 description: Found - '403': *423 + '403': *427 '404': *6 '503': *114 x-github: @@ -66745,8 +68367,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *327 - - *328 + - *331 + - *332 - name: language in: path description: The language of the CodeQL database. @@ -66756,7 +68378,7 @@ paths: responses: '204': description: Response - '403': *429 + '403': *433 '404': *6 '503': *114 x-github: @@ -66784,8 +68406,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -66794,7 +68416,7 @@ paths: type: object additionalProperties: false properties: - language: &440 + language: &444 type: string description: The language targeted by the CodeQL query enum: @@ -66874,7 +68496,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &444 + schema: &448 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -66884,7 +68506,7 @@ paths: description: The ID of the variant analysis. controller_repo: *65 actor: *4 - query_language: *440 + query_language: *444 query_pack_url: type: string description: The download url for the query pack. @@ -66932,7 +68554,7 @@ paths: items: type: object properties: - repository: &441 + repository: &445 title: Repository Identifier description: Repository Identifier type: object @@ -66974,7 +68596,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &445 + analysis_status: &449 type: string description: The new status of the CodeQL variant analysis repository task. @@ -67006,7 +68628,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &442 + access_mismatch_repos: &446 type: object properties: repository_count: @@ -67021,7 +68643,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *441 + items: *445 required: - repository_count - repositories @@ -67044,8 +68666,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *442 - over_limit_repos: *442 + no_codeql_db_repos: *446 + over_limit_repos: *446 required: - access_mismatch_repos - not_found_repos @@ -67061,7 +68683,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &443 + value: &447 summary: Default response value: id: 1 @@ -67207,10 +68829,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *443 + value: *447 repository_lists: summary: Response for a successful variant analysis submission - value: *443 + value: *447 '404': *6 '422': description: Unable to process variant analysis submission @@ -67238,8 +68860,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *327 - - *328 + - *331 + - *332 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -67251,9 +68873,9 @@ paths: description: Response content: application/json: - schema: *444 + schema: *448 examples: - default: *443 + default: *447 '404': *6 '503': *114 x-github: @@ -67276,7 +68898,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *327 + - *331 - name: repo in: path description: The name of the controller repository. @@ -67311,7 +68933,7 @@ paths: type: object properties: repository: *65 - analysis_status: *445 + analysis_status: *449 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -67436,8 +69058,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -67530,7 +69152,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *423 + '403': *427 '404': *6 '503': *114 x-github: @@ -67551,8 +69173,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -67646,7 +69268,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *429 + '403': *433 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -67717,8 +69339,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -67726,7 +69348,7 @@ paths: schema: type: object properties: - commit_sha: *446 + commit_sha: *450 ref: type: string description: |- @@ -67786,7 +69408,7 @@ paths: schema: type: object properties: - id: *437 + id: *441 url: type: string description: The REST API URL for checking the status of the upload. @@ -67800,7 +69422,7 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *429 + '403': *433 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -67823,8 +69445,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *327 - - *328 + - *331 + - *332 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -67872,7 +69494,7 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *423 + '403': *427 '404': description: Not Found if the sarif id does not match any upload '503': *114 @@ -67897,8 +69519,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -67979,8 +69601,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *327 - - *328 + - *331 + - *332 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -68108,8 +69730,8 @@ paths: parameters: - *17 - *19 - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -68125,7 +69747,7 @@ paths: type: integer codespaces: type: array - items: *237 + items: *241 examples: default: value: @@ -68423,8 +70045,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -68488,17 +70110,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '400': *14 '401': *23 '403': *27 @@ -68527,8 +70149,8 @@ paths: parameters: - *17 - *19 - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -68592,8 +70214,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -68630,9 +70252,9 @@ paths: type: integer machines: type: array - items: *448 + items: *452 examples: - default: &663 + default: &667 value: total_count: 2 machines: @@ -68672,8 +70294,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *327 - - *328 + - *331 + - *332 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -68760,8 +70382,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *327 - - *328 + - *331 + - *332 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -68830,8 +70452,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -68849,7 +70471,7 @@ paths: type: integer secrets: type: array - items: &452 + items: &456 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -68870,7 +70492,7 @@ paths: - created_at - updated_at examples: - default: *449 + default: *453 headers: Link: *66 x-github: @@ -68893,16 +70515,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *450 + schema: *454 examples: - default: *451 + default: *455 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -68922,17 +70544,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 responses: '200': description: Response content: application/json: - schema: *452 + schema: *456 examples: - default: *453 + default: *457 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68952,8 +70574,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 requestBody: required: true @@ -69006,8 +70628,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 responses: '204': @@ -69036,8 +70658,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *327 - - *328 + - *331 + - *332 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -69075,7 +70697,7 @@ paths: application/json: schema: type: array - items: &454 + items: &458 title: Collaborator description: Collaborator type: object @@ -69268,8 +70890,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *327 - - *328 + - *331 + - *332 - *70 responses: '204': @@ -69316,8 +70938,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *327 - - *328 + - *331 + - *332 - *70 requestBody: required: false @@ -69344,7 +70966,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &524 + schema: &528 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -69572,8 +71194,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *327 - - *328 + - *331 + - *332 - *70 responses: '204': @@ -69605,8 +71227,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *327 - - *328 + - *331 + - *332 - *70 responses: '200': @@ -69627,7 +71249,7 @@ paths: user: anyOf: - type: 'null' - - *454 + - *458 required: - permission - role_name @@ -69681,8 +71303,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -69692,7 +71314,7 @@ paths: application/json: schema: type: array - items: &455 + items: &459 title: Commit Comment description: Commit Comment type: object @@ -69750,7 +71372,7 @@ paths: - created_at - updated_at examples: - default: &460 + default: &464 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -69809,17 +71431,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '200': description: Response content: application/json: - schema: *455 + schema: *459 examples: - default: &461 + default: &465 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -69876,8 +71498,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 requestBody: required: true @@ -69900,7 +71522,7 @@ paths: description: Response content: application/json: - schema: *455 + schema: *459 examples: default: value: @@ -69951,8 +71573,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '204': @@ -69974,8 +71596,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -70002,7 +71624,7 @@ paths: application/json: schema: type: array - items: &456 + items: &460 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -70046,7 +71668,7 @@ paths: - content - created_at examples: - default: &527 + default: &531 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -70091,8 +71713,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 requestBody: required: true @@ -70125,9 +71747,9 @@ paths: description: Reaction exists content: application/json: - schema: *456 + schema: *460 examples: - default: &457 + default: &461 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -70156,9 +71778,9 @@ paths: description: Reaction created content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '422': *15 x-github: githubCloudOnly: false @@ -70180,10 +71802,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *327 - - *328 + - *331 + - *332 - *96 - - &528 + - &532 name: reaction_id description: The unique identifier of the reaction. in: path @@ -70238,8 +71860,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *327 - - *328 + - *331 + - *332 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -70295,9 +71917,9 @@ paths: application/json: schema: type: array - items: *458 + items: *462 examples: - default: &575 + default: &579 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -70391,9 +72013,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *327 - - *328 - - &459 + - *331 + - *332 + - &463 name: commit_sha description: The SHA of the commit. in: path @@ -70465,9 +72087,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *327 - - *328 - - *459 + - *331 + - *332 + - *463 - *17 - *19 responses: @@ -70477,9 +72099,9 @@ paths: application/json: schema: type: array - items: *455 + items: *459 examples: - default: *460 + default: *464 headers: Link: *66 x-github: @@ -70507,9 +72129,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *327 - - *328 - - *459 + - *331 + - *332 + - *463 requestBody: required: true content: @@ -70544,9 +72166,9 @@ paths: description: Response content: application/json: - schema: *455 + schema: *459 examples: - default: *461 + default: *465 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -70574,9 +72196,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *327 - - *328 - - *459 + - *331 + - *332 + - *463 - *17 - *19 responses: @@ -70586,9 +72208,9 @@ paths: application/json: schema: type: array - items: *462 + items: *466 examples: - default: &567 + default: &571 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -71125,11 +72747,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *327 - - *328 + - *331 + - *332 - *19 - *17 - - &463 + - &467 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -71144,9 +72766,9 @@ paths: description: Response content: application/json: - schema: *458 + schema: *462 examples: - default: &555 + default: &559 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -71234,7 +72856,7 @@ paths: schema: type: string examples: - default: &470 + default: &474 value: | diff --git a/testfile b/testfile index 9bdeaeb..912c7ef 100644 @@ -71247,7 +72869,7 @@ paths: schema: type: string examples: - default: &471 + default: &475 value: | From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001 From: Mona Lisa <87831417+monalisa@users.noreply.github.com> @@ -71300,11 +72922,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *327 - - *328 - - *463 - - *464 - - *465 + - *331 + - *332 + - *467 + - *468 + - *469 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -71338,9 +72960,9 @@ paths: type: integer check_runs: type: array - items: *405 + items: *409 examples: - default: *466 + default: *470 headers: Link: *66 x-github: @@ -71365,9 +72987,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *327 - - *328 - - *463 + - *331 + - *332 + - *467 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -71375,7 +72997,7 @@ paths: schema: type: integer example: 1 - - *464 + - *468 - *17 - *19 responses: @@ -71393,7 +73015,7 @@ paths: type: integer check_suites: type: array - items: *409 + items: *413 examples: default: value: @@ -71593,9 +73215,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *327 - - *328 - - *463 + - *331 + - *332 + - *467 - *17 - *19 responses: @@ -71797,9 +73419,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *327 - - *328 - - *463 + - *331 + - *332 + - *467 - *17 - *19 responses: @@ -71809,7 +73431,7 @@ paths: application/json: schema: type: array - items: &643 + items: &647 title: Status description: The status of a commit. type: object @@ -71890,7 +73512,7 @@ paths: site_admin: false headers: Link: *66 - '301': *331 + '301': *335 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71918,8 +73540,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -71952,11 +73574,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *467 + - *471 code_of_conduct_file: anyOf: - type: 'null' - - &468 + - &472 title: Community Health File type: object properties: @@ -71976,19 +73598,19 @@ paths: contributing: anyOf: - type: 'null' - - *468 + - *472 readme: anyOf: - type: 'null' - - *468 + - *472 issue_template: anyOf: - type: 'null' - - *468 + - *472 pull_request_template: anyOf: - type: 'null' - - *468 + - *472 required: - code_of_conduct - code_of_conduct_file @@ -72117,8 +73739,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *327 - - *328 + - *331 + - *332 - *19 - *17 - name: basehead @@ -72166,8 +73788,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *458 - merge_base_commit: *458 + base_commit: *462 + merge_base_commit: *462 status: type: string enum: @@ -72191,10 +73813,10 @@ paths: - 6 commits: type: array - items: *458 + items: *462 files: type: array - items: *469 + items: *473 required: - url - html_url @@ -72440,12 +74062,12 @@ paths: schema: type: string examples: - default: *470 + default: *474 application/vnd.github.patch: schema: type: string examples: - default: *471 + default: *475 '404': *6 '500': *53 '503': *114 @@ -72490,8 +74112,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *327 - - *328 + - *331 + - *332 - name: path description: path parameter in: path @@ -72661,7 +74283,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &472 + response-if-content-is-a-file-github-object: &476 summary: Response if content is a file value: type: file @@ -72798,7 +74420,7 @@ paths: - size - type - url - - &580 + - &584 title: Content File description: Content File type: object @@ -73016,7 +74638,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *472 + response-if-content-is-a-file: *476 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -73085,7 +74707,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *473 + '302': *477 '304': *35 x-github: githubCloudOnly: false @@ -73108,8 +74730,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *327 - - *328 + - *331 + - *332 - name: path description: path parameter in: path @@ -73204,7 +74826,7 @@ paths: description: Response content: application/json: - schema: &474 + schema: &478 title: File Commit description: File Commit type: object @@ -73360,7 +74982,7 @@ paths: description: Response content: application/json: - schema: *474 + schema: *478 examples: example-for-creating-a-file: value: @@ -73414,7 +75036,7 @@ paths: schema: oneOf: - *3 - - &506 + - &510 description: Repository rule violation was detected type: object properties: @@ -73435,7 +75057,7 @@ paths: items: type: object properties: - placeholder_id: &635 + placeholder_id: &639 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -73467,8 +75089,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *327 - - *328 + - *331 + - *332 - name: path description: path parameter in: path @@ -73529,7 +75151,7 @@ paths: description: Response content: application/json: - schema: *474 + schema: *478 examples: default: value: @@ -73584,8 +75206,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *327 - - *328 + - *331 + - *332 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -73709,24 +75331,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *327 - - *328 - - *189 - - *190 - - *191 - - *192 + - *331 + - *332 - *193 + - *194 + - *195 + - *196 + - *197 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *194 - - *475 - - *195 - - *196 - - *197 + - *198 + - *479 + - *199 + - *200 + - *201 - *60 - *45 - *46 @@ -73738,7 +75360,7 @@ paths: application/json: schema: type: array - items: &479 + items: &483 type: object description: A Dependabot alert. properties: @@ -73789,7 +75411,7 @@ paths: - transitive - inconclusive - - security_advisory: *476 + security_advisory: *480 security_vulnerability: *64 url: *174 html_url: *175 @@ -73820,8 +75442,8 @@ paths: dismissal. maxLength: 280 fixed_at: *176 - auto_dismissed_at: *477 - dismissal_request: *478 + auto_dismissed_at: *481 + dismissal_request: *482 assignees: type: array description: The users assigned to this alert. @@ -74076,9 +75698,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *327 - - *328 - - &480 + - *331 + - *332 + - &484 name: alert_number in: path description: |- @@ -74093,7 +75715,7 @@ paths: description: Response content: application/json: - schema: *479 + schema: *483 examples: default: value: @@ -74225,9 +75847,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *327 - - *328 - - *480 + - *331 + - *332 + - *484 requestBody: required: true content: @@ -74283,7 +75905,7 @@ paths: description: Response content: application/json: - schema: *479 + schema: *483 examples: default: value: @@ -74413,8 +76035,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -74432,7 +76054,7 @@ paths: type: integer secrets: type: array - items: &483 + items: &487 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -74486,16 +76108,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *481 + schema: *485 examples: - default: *482 + default: *486 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74515,15 +76137,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 responses: '200': description: Response content: application/json: - schema: *483 + schema: *487 examples: default: value: @@ -74549,8 +76171,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 requestBody: required: true @@ -74603,8 +76225,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 responses: '204': @@ -74627,8 +76249,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *327 - - *328 + - *331 + - *332 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -74802,8 +76424,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -75062,8 +76684,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - name: sbom_uuid in: path required: true @@ -75074,7 +76696,7 @@ paths: '302': description: Redirects to a temporary download URL for the completed SBOM. headers: - Location: *484 + Location: *488 '202': description: SBOM is still being processed, no content is returned. '404': *6 @@ -75095,8 +76717,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '201': description: Response @@ -75134,8 +76756,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -75218,7 +76840,7 @@ paths: - version - url additionalProperties: false - metadata: &485 + metadata: &489 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -75257,7 +76879,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *485 + metadata: *489 resolved: type: object description: A collection of resolved package dependencies. @@ -75271,7 +76893,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *485 + metadata: *489 relationship: type: string description: A notation of whether a dependency is requested @@ -75404,8 +77026,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *327 - - *328 + - *331 + - *332 - name: sha description: The SHA recorded at creation time. in: query @@ -75446,9 +77068,9 @@ paths: application/json: schema: type: array - items: *486 + items: *490 examples: - default: *487 + default: *491 headers: Link: *66 x-github: @@ -75514,8 +77136,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -75597,7 +77219,7 @@ paths: description: Response content: application/json: - schema: *486 + schema: *490 examples: simple-example: summary: Simple example @@ -75670,9 +77292,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *327 - - *328 - - &488 + - *331 + - *332 + - &492 name: deployment_id description: deployment_id parameter in: path @@ -75684,7 +77306,7 @@ paths: description: Response content: application/json: - schema: *486 + schema: *490 examples: default: value: @@ -75749,9 +77371,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *327 - - *328 - - *488 + - *331 + - *332 + - *492 responses: '204': description: Response @@ -75773,9 +77395,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *327 - - *328 - - *488 + - *331 + - *332 + - *492 - *17 - *19 responses: @@ -75785,7 +77407,7 @@ paths: application/json: schema: type: array - items: &489 + items: &493 title: Deployment Status description: The status of a deployment. type: object @@ -75949,9 +77571,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *327 - - *328 - - *488 + - *331 + - *332 + - *492 requestBody: required: true content: @@ -76026,9 +77648,9 @@ paths: description: Response content: application/json: - schema: *489 + schema: *493 examples: - default: &490 + default: &494 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -76084,9 +77706,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *327 - - *328 - - *488 + - *331 + - *332 + - *492 - name: status_id in: path required: true @@ -76097,9 +77719,9 @@ paths: description: Response content: application/json: - schema: *489 + schema: *493 examples: - default: *490 + default: *494 '404': *6 x-github: githubCloudOnly: false @@ -76124,8 +77746,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -76182,8 +77804,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -76201,7 +77823,7 @@ paths: - 5 environments: type: array - items: &492 + items: &496 title: Environment description: Details of a deployment environment type: object @@ -76263,7 +77885,7 @@ paths: type: string examples: - wait_timer - wait_timer: &494 + wait_timer: &498 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -76305,11 +77927,11 @@ paths: items: type: object properties: - type: *491 + type: *495 reviewer: anyOf: - *4 - - *187 + - *191 required: - id - node_id @@ -76332,7 +77954,7 @@ paths: - id - node_id - type - deployment_branch_policy: &495 + deployment_branch_policy: &499 type: - object - 'null' @@ -76449,9 +78071,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *327 - - *328 - - &493 + - *331 + - *332 + - &497 name: environment_name in: path required: true @@ -76464,9 +78086,9 @@ paths: description: Response content: application/json: - schema: *492 + schema: *496 examples: - default: &496 + default: &500 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -76550,9 +78172,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 requestBody: required: false content: @@ -76562,7 +78184,7 @@ paths: - object - 'null' properties: - wait_timer: *494 + wait_timer: *498 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -76581,14 +78203,14 @@ paths: items: type: object properties: - type: *491 + type: *495 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *495 + deployment_branch_policy: *499 additionalProperties: false examples: default: @@ -76608,9 +78230,9 @@ paths: description: Response content: application/json: - schema: *492 + schema: *496 examples: - default: *496 + default: *500 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -76634,9 +78256,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 responses: '204': description: Default response @@ -76661,9 +78283,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 - *17 - *19 responses: @@ -76682,7 +78304,7 @@ paths: - 2 branch_policies: type: array - items: &497 + items: &501 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -76743,9 +78365,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 requestBody: required: true content: @@ -76793,9 +78415,9 @@ paths: description: Response content: application/json: - schema: *497 + schema: *501 examples: - example-wildcard: &498 + example-wildcard: &502 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -76837,10 +78459,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *327 - - *328 - - *493 - - &499 + - *331 + - *332 + - *497 + - &503 name: branch_policy_id in: path required: true @@ -76852,9 +78474,9 @@ paths: description: Response content: application/json: - schema: *497 + schema: *501 examples: - default: *498 + default: *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76873,10 +78495,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *327 - - *328 - - *493 - - *499 + - *331 + - *332 + - *497 + - *503 requestBody: required: true content: @@ -76905,9 +78527,9 @@ paths: description: Response content: application/json: - schema: *497 + schema: *501 examples: - default: *498 + default: *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76926,10 +78548,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *327 - - *328 - - *493 - - *499 + - *331 + - *332 + - *497 + - *503 responses: '204': description: Response @@ -76954,9 +78576,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *493 - - *328 - - *327 + - *497 + - *332 + - *331 responses: '200': description: List of deployment protection rules @@ -76973,7 +78595,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &500 + items: &504 title: Deployment protection rule description: Deployment protection rule type: object @@ -76995,7 +78617,7 @@ paths: for the environment. examples: - true - app: &501 + app: &505 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -77098,9 +78720,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *493 - - *328 - - *327 + - *497 + - *332 + - *331 requestBody: content: application/json: @@ -77121,9 +78743,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *500 + schema: *504 examples: - default: &502 + default: &506 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -77158,9 +78780,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *493 - - *328 - - *327 + - *497 + - *332 + - *331 - *19 - *17 responses: @@ -77180,7 +78802,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *501 + items: *505 examples: default: value: @@ -77215,10 +78837,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *327 - - *328 - - *493 - - &503 + - *331 + - *332 + - *497 + - &507 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -77230,9 +78852,9 @@ paths: description: Response content: application/json: - schema: *500 + schema: *504 examples: - default: *502 + default: *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77253,10 +78875,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *493 - - *328 - - *327 - - *503 + - *497 + - *332 + - *331 + - *507 responses: '204': description: Response @@ -77282,9 +78904,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 - *17 - *19 responses: @@ -77302,9 +78924,9 @@ paths: type: integer secrets: type: array - items: *372 + items: *376 examples: - default: *373 + default: *377 headers: Link: *66 x-github: @@ -77329,17 +78951,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 responses: '200': description: Response content: application/json: - schema: *374 + schema: *378 examples: - default: *375 + default: *379 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77361,18 +78983,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 - *161 responses: '200': description: Response content: application/json: - schema: *372 + schema: *376 examples: - default: *504 + default: *508 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77394,9 +79016,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 - *161 requestBody: required: true @@ -77454,9 +79076,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 - *161 responses: '204': @@ -77482,10 +79104,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *327 - - *328 - - *493 - - *343 + - *331 + - *332 + - *497 + - *347 - *19 responses: '200': @@ -77502,9 +79124,9 @@ paths: type: integer variables: type: array - items: *376 + items: *380 examples: - default: *377 + default: *381 headers: Link: *66 x-github: @@ -77527,9 +79149,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 requestBody: required: true content: @@ -77581,18 +79203,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 - *164 responses: '200': description: Response content: application/json: - schema: *376 + schema: *380 examples: - default: *505 + default: *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77613,10 +79235,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *327 - - *328 + - *331 + - *332 - *164 - - *493 + - *497 requestBody: required: true content: @@ -77658,10 +79280,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *327 - - *328 + - *331 + - *332 - *164 - - *493 + - *497 responses: '204': description: Response @@ -77683,8 +79305,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -77752,8 +79374,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *327 - - *328 + - *331 + - *332 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -77912,8 +79534,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: false content: @@ -77946,9 +79568,9 @@ paths: description: Response content: application/json: - schema: *330 + schema: *334 examples: - default: *332 + default: *336 '400': *14 '422': *15 '403': *27 @@ -77969,8 +79591,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -78030,7 +79652,7 @@ paths: schema: oneOf: - *122 - - *506 + - *510 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78055,8 +79677,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *327 - - *328 + - *331 + - *332 - name: file_sha in: path required: true @@ -78156,8 +79778,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -78266,7 +79888,7 @@ paths: description: Response content: application/json: - schema: &507 + schema: &511 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -78493,15 +80115,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *327 - - *328 - - *459 + - *331 + - *332 + - *463 responses: '200': description: Response content: application/json: - schema: *507 + schema: *511 examples: default: value: @@ -78557,9 +80179,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *327 - - *328 - - &508 + - *331 + - *332 + - &512 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -78576,7 +80198,7 @@ paths: application/json: schema: type: array - items: &509 + items: &513 title: Git Reference description: Git references within a repository type: object @@ -78652,17 +80274,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *327 - - *328 - - *508 + - *331 + - *332 + - *512 responses: '200': description: Response content: application/json: - schema: *509 + schema: *513 examples: - default: &510 + default: &514 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -78691,8 +80313,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -78721,9 +80343,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *513 examples: - default: *510 + default: *514 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -78749,9 +80371,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *327 - - *328 - - *508 + - *331 + - *332 + - *512 requestBody: required: true content: @@ -78780,9 +80402,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *513 examples: - default: *510 + default: *514 '422': *15 '409': *52 x-github: @@ -78800,9 +80422,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *327 - - *328 - - *508 + - *331 + - *332 + - *512 responses: '204': description: Response @@ -78857,8 +80479,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -78925,7 +80547,7 @@ paths: description: Response content: application/json: - schema: &512 + schema: &516 title: Git Tag description: Metadata for a Git tag type: object @@ -78981,7 +80603,7 @@ paths: - sha - type - url - verification: *511 + verification: *515 required: - sha - url @@ -78991,7 +80613,7 @@ paths: - tag - message examples: - default: &513 + default: &517 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -79064,8 +80686,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *327 - - *328 + - *331 + - *332 - name: tag_sha in: path required: true @@ -79076,9 +80698,9 @@ paths: description: Response content: application/json: - schema: *512 + schema: *516 examples: - default: *513 + default: *517 '404': *6 '409': *52 x-github: @@ -79102,8 +80724,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -79177,7 +80799,7 @@ paths: description: Response content: application/json: - schema: &514 + schema: &518 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -79279,8 +80901,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *327 - - *328 + - *331 + - *332 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -79303,7 +80925,7 @@ paths: description: Response content: application/json: - schema: *514 + schema: *518 examples: default-response: summary: Default response @@ -79362,8 +80984,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -79373,7 +80995,7 @@ paths: application/json: schema: type: array - items: &515 + items: &519 title: Webhook description: Webhooks for repositories. type: object @@ -79436,7 +81058,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &750 + last_response: &755 title: Hook Response type: object properties: @@ -79513,8 +81135,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: false content: @@ -79567,9 +81189,9 @@ paths: description: Response content: application/json: - schema: *515 + schema: *519 examples: - default: &516 + default: &520 value: type: Repository id: 12345678 @@ -79617,17 +81239,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 responses: '200': description: Response content: application/json: - schema: *515 + schema: *519 examples: - default: *516 + default: *520 '404': *6 x-github: githubCloudOnly: false @@ -79647,9 +81269,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 requestBody: required: true content: @@ -79694,9 +81316,9 @@ paths: description: Response content: application/json: - schema: *515 + schema: *519 examples: - default: *516 + default: *520 '422': *15 '404': *6 x-github: @@ -79717,9 +81339,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 responses: '204': description: Response @@ -79743,9 +81365,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 responses: '200': description: Response @@ -79772,9 +81394,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 requestBody: required: false content: @@ -79818,12 +81440,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 - *17 - - *206 - - *207 + - *210 + - *211 responses: '200': description: Response @@ -79831,9 +81453,9 @@ paths: application/json: schema: type: array - items: *208 + items: *212 examples: - default: *209 + default: *213 '400': *14 '422': *15 x-github: @@ -79852,18 +81474,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 - *16 responses: '200': description: Response content: application/json: - schema: *210 + schema: *214 examples: - default: *211 + default: *215 '400': *14 '422': *15 x-github: @@ -79882,9 +81504,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 - *16 responses: '202': *37 @@ -79907,9 +81529,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 responses: '204': description: Response @@ -79934,9 +81556,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 responses: '204': description: Response @@ -79959,8 +81581,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response if immutable releases are enabled @@ -80008,8 +81630,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': *59 '409': *52 @@ -80029,8 +81651,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': *59 '409': *52 @@ -80087,14 +81709,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: &517 + schema: &521 title: Import description: A repository import from an external source. type: object @@ -80201,7 +81823,7 @@ paths: - html_url - authors_url examples: - default: &520 + default: &524 value: vcs: subversion use_lfs: true @@ -80217,7 +81839,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &518 + '503': &522 description: Unavailable due to service under maintenance. content: application/json: @@ -80246,8 +81868,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -80295,7 +81917,7 @@ paths: description: Response content: application/json: - schema: *517 + schema: *521 examples: default: value: @@ -80320,7 +81942,7 @@ paths: type: string '422': *15 '404': *6 - '503': *518 + '503': *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80348,8 +81970,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: false content: @@ -80401,7 +82023,7 @@ paths: description: Response content: application/json: - schema: *517 + schema: *521 examples: example-1: summary: Example 1 @@ -80449,7 +82071,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *518 + '503': *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80472,12 +82094,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response - '503': *518 + '503': *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80503,9 +82125,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *327 - - *328 - - &684 + - *331 + - *332 + - &688 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -80519,7 +82141,7 @@ paths: application/json: schema: type: array - items: &519 + items: &523 title: Porter Author description: Porter Author type: object @@ -80573,7 +82195,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *518 + '503': *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80598,8 +82220,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *327 - - *328 + - *331 + - *332 - name: author_id in: path required: true @@ -80629,7 +82251,7 @@ paths: description: Response content: application/json: - schema: *519 + schema: *523 examples: default: value: @@ -80642,7 +82264,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *518 + '503': *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80666,8 +82288,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -80708,7 +82330,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *518 + '503': *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80736,8 +82358,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -80764,11 +82386,11 @@ paths: description: Response content: application/json: - schema: *517 + schema: *521 examples: - default: *520 + default: *524 '422': *15 - '503': *518 + '503': *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80791,8 +82413,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -80800,8 +82422,8 @@ paths: application/json: schema: *20 examples: - default: *521 - '301': *331 + default: *525 + '301': *335 '404': *6 x-github: githubCloudOnly: false @@ -80821,8 +82443,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -80830,12 +82452,12 @@ paths: application/json: schema: anyOf: - - *224 + - *228 - type: object properties: {} additionalProperties: false examples: - default: &523 + default: &527 value: limit: collaborators_only origin: repository @@ -80860,13 +82482,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: application/json: - schema: *522 + schema: *526 examples: default: summary: Example request body @@ -80878,9 +82500,9 @@ paths: description: Response content: application/json: - schema: *224 + schema: *228 examples: - default: *523 + default: *527 '409': description: Response x-github: @@ -80902,8 +82524,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -80926,8 +82548,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -80937,9 +82559,9 @@ paths: application/json: schema: type: array - items: *524 + items: *528 examples: - default: &677 + default: &681 value: - id: 1 repository: @@ -81070,9 +82692,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *327 - - *328 - - *228 + - *331 + - *332 + - *232 requestBody: required: false content: @@ -81101,7 +82723,7 @@ paths: description: Response content: application/json: - schema: *524 + schema: *528 examples: default: value: @@ -81232,9 +82854,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *327 - - *328 - - *228 + - *331 + - *332 + - *232 responses: '204': description: Response @@ -81265,8 +82887,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *327 - - *328 + - *331 + - *332 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -81314,7 +82936,7 @@ paths: required: false schema: type: string - - *235 + - *239 - name: sort description: What to sort results by. in: query @@ -81339,7 +82961,7 @@ paths: type: array items: *82 examples: - default: &533 + default: &537 value: - id: 1 node_id: MDU6SXNzdWUx @@ -81488,7 +83110,7 @@ paths: state_reason: completed headers: Link: *66 - '301': *331 + '301': *335 '422': *15 '404': *6 x-github: @@ -81517,8 +83139,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -81610,7 +83232,7 @@ paths: application/json: schema: *82 examples: - default: &530 + default: &534 value: id: 1 node_id: MDU6SXNzdWUx @@ -81767,7 +83389,7 @@ paths: '422': *15 '503': *114 '404': *6 - '410': *525 + '410': *529 x-github: triggersNotification: true githubCloudOnly: false @@ -81795,8 +83417,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *104 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -81819,7 +83441,7 @@ paths: type: array items: *83 examples: - default: &532 + default: &536 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -81877,8 +83499,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '200': @@ -81887,7 +83509,7 @@ paths: application/json: schema: *83 examples: - default: &526 + default: &530 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -81942,8 +83564,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 requestBody: required: true @@ -81968,7 +83590,7 @@ paths: application/json: schema: *83 examples: - default: *526 + default: *530 '422': *15 x-github: githubCloudOnly: false @@ -81986,8 +83608,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '204': @@ -82016,8 +83638,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#pin-an-issue-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '200': @@ -82080,7 +83702,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *525 + '410': *529 '422': *15 x-github: githubCloudOnly: false @@ -82097,8 +83719,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#unpin-an-issue-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '204': @@ -82106,7 +83728,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *525 + '410': *529 '503': *114 x-github: githubCloudOnly: false @@ -82124,8 +83746,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -82152,9 +83774,9 @@ paths: application/json: schema: type: array - items: *456 + items: *460 examples: - default: *527 + default: *531 headers: Link: *66 '404': *6 @@ -82175,8 +83797,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 requestBody: required: true @@ -82209,16 +83831,16 @@ paths: description: Reaction exists content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '201': description: Reaction created content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '422': *15 x-github: githubCloudOnly: false @@ -82240,10 +83862,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *327 - - *328 + - *331 + - *332 - *96 - - *528 + - *532 responses: '204': description: Response @@ -82263,8 +83885,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -82274,7 +83896,7 @@ paths: application/json: schema: type: array - items: &529 + items: &533 title: Issue Event description: Issue Event type: object @@ -82354,7 +83976,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *187 + requested_team: *191 dismissed_review: title: Issue Event Dismissed Review type: object @@ -82614,8 +84236,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *327 - - *328 + - *331 + - *332 - name: event_id in: path required: true @@ -82626,7 +84248,7 @@ paths: description: Response content: application/json: - schema: *529 + schema: *533 examples: default: value: @@ -82819,7 +84441,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *525 + '410': *529 '403': *27 x-github: githubCloudOnly: false @@ -82853,9 +84475,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *327 - - *328 - - &531 + - *331 + - *332 + - &535 name: issue_number description: The number that identifies the issue. in: path @@ -82871,7 +84493,7 @@ paths: examples: default: summary: Issue - value: *530 + value: *534 pinned_comment: summary: Issue with pinned comment value: @@ -83070,9 +84692,9 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 '304': *35 x-github: githubCloudOnly: false @@ -83097,9 +84719,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: false content: @@ -83240,13 +84862,13 @@ paths: application/json: schema: *82 examples: - default: *530 + default: *534 '422': *15 '503': *114 '403': *27 - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83264,9 +84886,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: false content: @@ -83294,7 +84916,7 @@ paths: application/json: schema: *82 examples: - default: *530 + default: *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83310,9 +84932,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: content: application/json: @@ -83339,7 +84961,7 @@ paths: application/json: schema: *82 examples: - default: *530 + default: *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83361,9 +84983,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - name: assignee in: path required: true @@ -83403,9 +85025,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *87 - *17 - *19 @@ -83418,11 +85040,11 @@ paths: type: array items: *83 examples: - default: *532 + default: *536 headers: Link: *66 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83451,9 +85073,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -83477,14 +85099,14 @@ paths: application/json: schema: *83 examples: - default: *526 + default: *530 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *525 + '410': *529 '422': *15 '404': *6 x-github: @@ -83512,9 +85134,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *17 - *19 responses: @@ -83526,12 +85148,12 @@ paths: type: array items: *82 examples: - default: *533 + default: *537 headers: Link: *66 - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83559,9 +85181,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -83585,15 +85207,15 @@ paths: application/json: schema: *82 examples: - default: *530 + default: *534 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *331 + '301': *335 '403': *27 - '410': *525 + '410': *529 '422': *15 '404': *6 x-github: @@ -83624,9 +85246,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -83640,13 +85262,13 @@ paths: application/json: schema: *82 examples: - default: *530 - '301': *331 + default: *534 + '301': *335 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *525 + '410': *529 x-github: triggersNotification: true githubCloudOnly: false @@ -83672,9 +85294,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *17 - *19 responses: @@ -83686,12 +85308,12 @@ paths: type: array items: *82 examples: - default: *533 + default: *537 headers: Link: *66 - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83708,9 +85330,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *17 - *19 responses: @@ -83724,7 +85346,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &537 + - &541 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -83773,7 +85395,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &538 + - &542 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -83901,7 +85523,7 @@ paths: - performed_via_github_app - assignee - assigner - - &539 + - &543 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -83947,7 +85569,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &540 + - &544 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -83993,7 +85615,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &541 + - &545 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -84042,7 +85664,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &542 + - &546 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -84071,7 +85693,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *187 + requested_team: *191 requested_reviewer: *4 required: - review_requester @@ -84084,7 +85706,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &543 + - &547 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -84113,7 +85735,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *187 + requested_team: *191 requested_reviewer: *4 required: - review_requester @@ -84126,7 +85748,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &544 + - &548 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -84182,7 +85804,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &545 + - &549 title: Locked Issue Event description: Locked Issue Event type: object @@ -84227,7 +85849,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &546 + - &550 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -84288,7 +85910,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &547 + - &551 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -84349,7 +85971,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &548 + - &552 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -84410,7 +86032,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &549 + - &553 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -84503,7 +86125,7 @@ paths: color: red headers: Link: *66 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84520,9 +86142,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#list-issue-field-values-for-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *17 - *19 responses: @@ -84532,9 +86154,9 @@ paths: application/json: schema: type: array - items: *534 + items: *538 examples: - default: &535 + default: &539 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -84558,9 +86180,9 @@ paths: value: '2025-12-25' headers: Link: *66 - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84589,9 +86211,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -84657,9 +86279,9 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *534 + items: *538 examples: - default: *535 + default: *539 '400': *14 '403': *27 '404': *6 @@ -84695,9 +86317,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -84764,9 +86386,9 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *534 + items: *538 examples: - default: *535 + default: *539 '400': *14 '403': *27 '404': *6 @@ -84797,10 +86419,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue parameters: - - *327 - - *328 - - *531 - - *231 + - *331 + - *332 + - *535 + - *235 responses: '204': description: Issue field value deleted successfully @@ -84825,9 +86447,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *17 - *19 responses: @@ -84839,7 +86461,7 @@ paths: type: array items: *81 examples: - default: &536 + default: &540 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -84857,9 +86479,9 @@ paths: default: false headers: Link: *66 - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84875,9 +86497,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: false content: @@ -84922,10 +86544,10 @@ paths: type: array items: *81 examples: - default: *536 - '301': *331 + default: *540 + '301': *335 '404': *6 - '410': *525 + '410': *529 '422': *15 x-github: githubCloudOnly: false @@ -84942,9 +86564,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: false content: @@ -85006,10 +86628,10 @@ paths: type: array items: *81 examples: - default: *536 - '301': *331 + default: *540 + '301': *335 '404': *6 - '410': *525 + '410': *529 '422': *15 x-github: githubCloudOnly: false @@ -85026,15 +86648,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 responses: '204': description: Response - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85053,9 +86675,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - name: name in: path required: true @@ -85079,9 +86701,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85101,9 +86723,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: false content: @@ -85132,7 +86754,7 @@ paths: '204': description: Response '403': *27 - '410': *525 + '410': *529 '404': *6 '422': *15 x-github: @@ -85150,9 +86772,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 responses: '204': description: Response @@ -85182,9 +86804,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 responses: '200': description: Response @@ -85192,10 +86814,10 @@ paths: application/json: schema: *82 examples: - default: *530 - '301': *331 + default: *534 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85212,9 +86834,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -85240,13 +86862,13 @@ paths: application/json: schema: type: array - items: *456 + items: *460 examples: - default: *527 + default: *531 headers: Link: *66 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85264,9 +86886,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -85298,16 +86920,16 @@ paths: description: Response content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '201': description: Response content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '422': *15 x-github: githubCloudOnly: false @@ -85329,10 +86951,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *327 - - *328 - - *531 - - *528 + - *331 + - *332 + - *535 + - *532 responses: '204': description: Response @@ -85361,9 +86983,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -85387,7 +87009,7 @@ paths: application/json: schema: *82 examples: - default: *530 + default: *534 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -85420,9 +87042,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *17 - *19 responses: @@ -85434,11 +87056,11 @@ paths: type: array items: *82 examples: - default: *533 + default: *537 headers: Link: *66 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85466,9 +87088,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -85497,14 +87119,14 @@ paths: application/json: schema: *82 examples: - default: *530 + default: *534 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *525 + '410': *529 '422': *15 '404': *6 x-github: @@ -85524,9 +87146,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -85559,7 +87181,7 @@ paths: application/json: schema: *82 examples: - default: *530 + default: *534 '403': *27 '404': *6 '422': *7 @@ -85581,9 +87203,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *17 - *19 responses: @@ -85598,10 +87220,6 @@ paths: description: Timeline Event type: object anyOf: - - *537 - - *538 - - *539 - - *540 - *541 - *542 - *543 @@ -85611,6 +87229,10 @@ paths: - *547 - *548 - *549 + - *550 + - *551 + - *552 + - *553 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -85667,7 +87289,7 @@ paths: pin: anyOf: - type: 'null' - - *550 + - *554 required: - event - actor @@ -85943,7 +87565,7 @@ paths: type: string comments: type: array - items: &569 + items: &573 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -86184,7 +87806,7 @@ paths: type: string comments: type: array - items: *455 + items: *459 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -86459,7 +88081,7 @@ paths: headers: Link: *66 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86476,8 +88098,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -86487,7 +88109,7 @@ paths: application/json: schema: type: array - items: &551 + items: &555 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -86555,8 +88177,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -86592,9 +88214,9 @@ paths: description: Response content: application/json: - schema: *551 + schema: *555 examples: - default: &552 + default: &556 value: id: 1 key: ssh-rsa AAA... @@ -86628,9 +88250,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *327 - - *328 - - &553 + - *331 + - *332 + - &557 name: key_id description: The unique identifier of the key. in: path @@ -86642,9 +88264,9 @@ paths: description: Response content: application/json: - schema: *551 + schema: *555 examples: - default: *552 + default: *556 '404': *6 x-github: githubCloudOnly: false @@ -86662,9 +88284,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *327 - - *328 - - *553 + - *331 + - *332 + - *557 responses: '204': description: Response @@ -86684,8 +88306,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -86697,7 +88319,7 @@ paths: type: array items: *81 examples: - default: *536 + default: *540 headers: Link: *66 '404': *6 @@ -86718,8 +88340,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -86757,7 +88379,7 @@ paths: application/json: schema: *81 examples: - default: &554 + default: &558 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -86789,8 +88411,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *327 - - *328 + - *331 + - *332 - name: name in: path required: true @@ -86803,7 +88425,7 @@ paths: application/json: schema: *81 examples: - default: *554 + default: *558 '404': *6 x-github: githubCloudOnly: false @@ -86820,8 +88442,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *327 - - *328 + - *331 + - *332 - name: name in: path required: true @@ -86886,8 +88508,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *327 - - *328 + - *331 + - *332 - name: name in: path required: true @@ -86913,8 +88535,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -86953,9 +88575,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *327 - - *328 - - *430 + - *331 + - *332 + - *434 responses: '200': description: Response @@ -87102,8 +88724,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -87168,8 +88790,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -87203,9 +88825,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *458 + schema: *462 examples: - default: *555 + default: *559 '204': description: Response when already merged '404': @@ -87230,8 +88852,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *327 - - *328 + - *331 + - *332 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -87272,7 +88894,7 @@ paths: application/json: schema: type: array - items: *268 + items: *272 examples: default: value: @@ -87328,8 +88950,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -87369,9 +88991,9 @@ paths: description: Response content: application/json: - schema: *268 + schema: *272 examples: - default: &556 + default: &560 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -87430,9 +89052,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *327 - - *328 - - &557 + - *331 + - *332 + - &561 name: milestone_number description: The number that identifies the milestone. in: path @@ -87444,9 +89066,9 @@ paths: description: Response content: application/json: - schema: *268 + schema: *272 examples: - default: *556 + default: *560 '404': *6 x-github: githubCloudOnly: false @@ -87463,9 +89085,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *327 - - *328 - - *557 + - *331 + - *332 + - *561 requestBody: required: false content: @@ -87503,9 +89125,9 @@ paths: description: Response content: application/json: - schema: *268 + schema: *272 examples: - default: *556 + default: *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87521,9 +89143,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *327 - - *328 - - *557 + - *331 + - *332 + - *561 responses: '204': description: Response @@ -87544,9 +89166,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *327 - - *328 - - *557 + - *331 + - *332 + - *561 - *17 - *19 responses: @@ -87558,7 +89180,7 @@ paths: type: array items: *81 examples: - default: *536 + default: *540 headers: Link: *66 x-github: @@ -87577,12 +89199,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *327 - - *328 - - *558 - - *559 + - *331 + - *332 + - *562 + - *563 - *87 - - *560 + - *564 - *17 - *19 responses: @@ -87594,7 +89216,7 @@ paths: type: array items: *107 examples: - default: *561 + default: *565 headers: Link: *66 x-github: @@ -87618,8 +89240,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: false content: @@ -87677,14 +89299,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: &562 + schema: &566 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -87828,7 +89450,7 @@ paths: - custom_404 - public examples: - default: &563 + default: &567 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -87869,8 +89491,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -87925,9 +89547,9 @@ paths: description: Response content: application/json: - schema: *562 + schema: *566 examples: - default: *563 + default: *567 '422': *15 '409': *52 x-github: @@ -87950,8 +89572,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -88051,8 +89673,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -88078,8 +89700,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -88089,7 +89711,7 @@ paths: application/json: schema: type: array - items: &564 + items: &568 title: Page Build description: Page Build type: object @@ -88181,8 +89803,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *327 - - *328 + - *331 + - *332 responses: '201': description: Response @@ -88229,16 +89851,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *564 + schema: *568 examples: - default: &565 + default: &569 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -88286,8 +89908,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *327 - - *328 + - *331 + - *332 - name: build_id in: path required: true @@ -88298,9 +89920,9 @@ paths: description: Response content: application/json: - schema: *564 + schema: *568 examples: - default: *565 + default: *569 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88320,8 +89942,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -88429,9 +90051,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *327 - - *328 - - &566 + - *331 + - *332 + - &570 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -88489,9 +90111,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *327 - - *328 - - *566 + - *331 + - *332 + - *570 responses: '204': *59 '404': *6 @@ -88518,8 +90140,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -88814,8 +90436,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Private vulnerability reporting status @@ -88852,8 +90474,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': *59 '422': *14 @@ -88874,8 +90496,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': *59 '422': *14 @@ -88897,8 +90519,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -88906,7 +90528,7 @@ paths: application/json: schema: type: array - items: *282 + items: *286 examples: default: value: @@ -88937,8 +90559,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -88950,7 +90572,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *282 + items: *286 required: - properties examples: @@ -89000,8 +90622,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *327 - - *328 + - *331 + - *332 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -89061,9 +90683,9 @@ paths: application/json: schema: type: array - items: *462 + items: *466 examples: - default: *567 + default: *571 headers: Link: *66 '304': *35 @@ -89095,8 +90717,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -89163,7 +90785,7 @@ paths: description: Response content: application/json: - schema: &571 + schema: &575 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -89292,7 +90914,7 @@ paths: milestone: anyOf: - type: 'null' - - *268 + - *272 active_lock_reason: type: - string @@ -89341,7 +90963,7 @@ paths: items: *4 requested_teams: type: array - items: *247 + items: *251 head: type: object properties: @@ -89379,14 +91001,14 @@ paths: _links: type: object properties: - comments: *269 - commits: *269 - statuses: *269 - html: *269 - issue: *269 - review_comments: *269 - review_comment: *269 - self: *269 + comments: *273 + commits: *273 + statuses: *273 + html: *273 + issue: *273 + review_comments: *273 + review_comment: *273 + self: *273 required: - comments - commits @@ -89397,7 +91019,7 @@ paths: - review_comment - self author_association: *79 - auto_merge: *568 + auto_merge: *572 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -89499,7 +91121,7 @@ paths: - merged_by - review_comments examples: - default: &572 + default: &576 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -90026,8 +91648,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - name: sort in: query required: false @@ -90056,9 +91678,9 @@ paths: application/json: schema: type: array - items: *569 + items: *573 examples: - default: &574 + default: &578 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -90135,17 +91757,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '200': description: Response content: application/json: - schema: *569 + schema: *573 examples: - default: &570 + default: &574 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -90220,8 +91842,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 + - *331 + - *332 - *96 requestBody: required: true @@ -90244,9 +91866,9 @@ paths: description: Response content: application/json: - schema: *569 + schema: *573 examples: - default: *570 + default: *574 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90262,8 +91884,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '204': @@ -90285,8 +91907,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -90313,9 +91935,9 @@ paths: application/json: schema: type: array - items: *456 + items: *460 examples: - default: *527 + default: *531 headers: Link: *66 '404': *6 @@ -90336,8 +91958,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 requestBody: required: true @@ -90370,16 +91992,16 @@ paths: description: Reaction exists content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '201': description: Reaction created content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '422': *15 x-github: githubCloudOnly: false @@ -90401,10 +92023,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *327 - - *328 + - *331 + - *332 - *96 - - *528 + - *532 responses: '204': description: Response @@ -90447,9 +92069,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *327 - - *328 - - &573 + - *331 + - *332 + - &577 name: pull_number description: The number that identifies the pull request. in: path @@ -90462,9 +92084,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *571 + schema: *575 examples: - default: *572 + default: *576 '304': *35 '404': *6 '406': @@ -90499,9 +92121,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: false content: @@ -90543,9 +92165,9 @@ paths: description: Response content: application/json: - schema: *571 + schema: *575 examples: - default: *572 + default: *576 '422': *15 '403': *27 x-github: @@ -90567,9 +92189,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 responses: '204': description: Response @@ -90594,9 +92216,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 responses: '204': description: Response @@ -90622,9 +92244,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: true content: @@ -90685,17 +92307,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '401': *23 '403': *27 '404': *6 @@ -90725,9 +92347,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 - *104 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -90748,9 +92370,9 @@ paths: application/json: schema: type: array - items: *569 + items: *573 examples: - default: *574 + default: *578 headers: Link: *66 x-github: @@ -90783,9 +92405,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: true content: @@ -90891,7 +92513,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *573 examples: example-for-a-multi-line-comment: value: @@ -90979,9 +92601,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 - *96 requestBody: required: true @@ -91004,7 +92626,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *573 examples: default: value: @@ -91090,9 +92712,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 - *17 - *19 responses: @@ -91102,9 +92724,9 @@ paths: application/json: schema: type: array - items: *458 + items: *462 examples: - default: *575 + default: *579 headers: Link: *66 x-github: @@ -91134,9 +92756,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 - *17 - *19 responses: @@ -91146,7 +92768,7 @@ paths: application/json: schema: type: array - items: *469 + items: *473 examples: default: value: @@ -91184,9 +92806,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 responses: '204': description: Response if pull request has been merged @@ -91209,9 +92831,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: false content: @@ -91323,9 +92945,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 responses: '200': description: Response @@ -91341,7 +92963,7 @@ paths: items: *4 teams: type: array - items: *187 + items: *191 required: - users - teams @@ -91400,9 +93022,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: false content: @@ -91439,7 +93061,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *466 examples: default: value: @@ -91975,9 +93597,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: true content: @@ -92011,7 +93633,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *466 examples: default: value: @@ -92516,9 +94138,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 - *17 - *19 responses: @@ -92528,7 +94150,7 @@ paths: application/json: schema: type: array - items: &576 + items: &580 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -92684,9 +94306,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: false content: @@ -92776,9 +94398,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: - default: &578 + default: &582 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -92841,10 +94463,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 - - &577 + - *331 + - *332 + - *577 + - &581 name: review_id description: The unique identifier of the review. in: path @@ -92856,9 +94478,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: - default: &579 + default: &583 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -92917,10 +94539,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 - *577 + - *581 requestBody: required: true content: @@ -92943,7 +94565,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: default: value: @@ -93005,18 +94627,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 - *577 + - *581 responses: '200': description: Response content: application/json: - schema: *576 + schema: *580 examples: - default: *578 + default: *582 '422': *7 '404': *6 x-github: @@ -93043,10 +94665,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *327 - - *328 - - *573 + - *331 + - *332 - *577 + - *581 - *17 - *19 responses: @@ -93144,9 +94766,9 @@ paths: _links: type: object properties: - self: *269 - html: *269 - pull_request: *269 + self: *273 + html: *273 + pull_request: *273 required: - self - html @@ -93304,10 +94926,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 - *577 + - *581 requestBody: required: true content: @@ -93336,7 +94958,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: default: value: @@ -93399,10 +95021,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 - *577 + - *581 requestBody: required: true content: @@ -93437,9 +95059,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: - default: *579 + default: *583 '404': *6 '422': *7 '403': *27 @@ -93461,9 +95083,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: false content: @@ -93527,8 +95149,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *327 - - *328 + - *331 + - *332 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -93541,9 +95163,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *584 examples: - default: &581 + default: &585 value: type: file encoding: base64 @@ -93585,8 +95207,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *327 - - *328 + - *331 + - *332 - name: dir description: The alternate path to look for a README file in: path @@ -93606,9 +95228,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *584 examples: - default: *581 + default: *585 '404': *6 '422': *15 x-github: @@ -93630,8 +95252,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -93641,7 +95263,7 @@ paths: application/json: schema: type: array - items: *582 + items: *586 examples: default: value: @@ -93735,8 +95357,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -93812,9 +95434,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *586 examples: - default: &586 + default: &590 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -93919,9 +95541,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *327 - - *328 - - &584 + - *331 + - *332 + - &588 name: asset_id description: The unique identifier of the asset. in: path @@ -93933,9 +95555,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *587 examples: - default: &585 + default: &589 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -93970,7 +95592,7 @@ paths: type: User site_admin: false '404': *6 - '302': *473 + '302': *477 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93986,9 +95608,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *327 - - *328 - - *584 + - *331 + - *332 + - *588 requestBody: required: false content: @@ -94017,9 +95639,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *587 examples: - default: *585 + default: *589 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94035,9 +95657,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *327 - - *328 - - *584 + - *331 + - *332 + - *588 responses: '204': description: Response @@ -94062,8 +95684,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -94149,16 +95771,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *582 + schema: *586 examples: - default: *586 + default: *590 '404': *6 x-github: githubCloudOnly: false @@ -94176,8 +95798,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *327 - - *328 + - *331 + - *332 - name: tag description: tag parameter in: path @@ -94190,9 +95812,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *586 examples: - default: *586 + default: *590 '404': *6 x-github: githubCloudOnly: false @@ -94214,9 +95836,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *327 - - *328 - - &587 + - *331 + - *332 + - &591 name: release_id description: The unique identifier of the release. in: path @@ -94230,9 +95852,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *582 + schema: *586 examples: - default: *586 + default: *590 '401': description: Unauthorized x-github: @@ -94250,9 +95872,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *327 - - *328 - - *587 + - *331 + - *332 + - *591 requestBody: required: false content: @@ -94316,9 +95938,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *586 examples: - default: *586 + default: *590 '404': description: Not Found if the discussion category name is invalid content: @@ -94339,9 +95961,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *327 - - *328 - - *587 + - *331 + - *332 + - *591 responses: '204': description: Response @@ -94362,9 +95984,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *327 - - *328 - - *587 + - *331 + - *332 + - *591 - *17 - *19 responses: @@ -94374,7 +95996,7 @@ paths: application/json: schema: type: array - items: *583 + items: *587 examples: default: value: @@ -94455,9 +96077,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *327 - - *328 - - *587 + - *331 + - *332 + - *591 - name: name in: query required: true @@ -94483,7 +96105,7 @@ paths: description: Response for successful upload content: application/json: - schema: *583 + schema: *587 examples: response-for-successful-upload: value: @@ -94538,9 +96160,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *327 - - *328 - - *587 + - *331 + - *332 + - *591 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -94564,9 +96186,9 @@ paths: application/json: schema: type: array - items: *456 + items: *460 examples: - default: *527 + default: *531 headers: Link: *66 '404': *6 @@ -94587,9 +96209,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *327 - - *328 - - *587 + - *331 + - *332 + - *591 requestBody: required: true content: @@ -94619,16 +96241,16 @@ paths: description: Reaction exists content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '201': description: Reaction created content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '422': *15 x-github: githubCloudOnly: false @@ -94650,10 +96272,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *327 - - *328 - - *587 - - *528 + - *331 + - *332 + - *591 + - *532 responses: '204': description: Response @@ -94677,9 +96299,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 - *17 - *19 responses: @@ -94695,8 +96317,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *289 - - &588 + - *293 + - &592 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -94715,69 +96337,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *290 - - *588 - - allOf: - - *291 - - *588 - - allOf: - - *292 - - *588 - - allOf: - - *589 - - *588 - - allOf: - - *293 - - *588 - allOf: - *294 - - *588 + - *592 - allOf: - *295 - - *588 + - *592 - allOf: - *296 - - *588 + - *592 + - allOf: + - *593 + - *592 - allOf: - *297 - - *588 + - *592 - allOf: - *298 - - *588 + - *592 - allOf: - *299 - - *588 + - *592 - allOf: - *300 - - *588 + - *592 - allOf: - *301 - - *588 + - *592 - allOf: - *302 - - *588 + - *592 - allOf: - *303 - - *588 + - *592 - allOf: - *304 - - *588 + - *592 - allOf: - *305 - - *588 + - *592 - allOf: - *306 - - *588 + - *592 - allOf: - *307 - - *588 + - *592 - allOf: - *308 - - *588 + - *592 - allOf: - *309 - - *588 + - *592 + - allOf: + - *310 + - *592 + - allOf: + - *311 + - *592 + - allOf: + - *312 + - *592 + - allOf: + - *313 + - *592 examples: default: value: @@ -94816,8 +96438,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 - name: includes_parents @@ -94828,7 +96450,7 @@ paths: schema: type: boolean default: true - - *590 + - *594 responses: '200': description: Response @@ -94836,7 +96458,7 @@ paths: application/json: schema: type: array - items: *310 + items: *314 examples: default: value: @@ -94883,8 +96505,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *331 + - *332 requestBody: description: Request body required: true @@ -94904,16 +96526,16 @@ paths: - tag - push default: branch - enforcement: *286 + enforcement: *290 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *287 - conditions: *284 + items: *291 + conditions: *288 rules: type: array description: An array of rules within the ruleset. - items: *591 + items: *595 required: - name - enforcement @@ -94944,9 +96566,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *314 examples: - default: &601 + default: &605 value: id: 42 name: super cool ruleset @@ -94994,12 +96616,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *327 - - *328 - - *592 - - *593 - - *594 - - *595 + - *331 + - *332 + - *596 + - *597 + - *598 + - *599 - *17 - *19 responses: @@ -95007,9 +96629,9 @@ paths: description: Response content: application/json: - schema: *596 + schema: *600 examples: - default: *597 + default: *601 '404': *6 '500': *53 x-github: @@ -95030,17 +96652,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *327 - - *328 - - *598 + - *331 + - *332 + - *602 responses: '200': description: Response content: application/json: - schema: *599 + schema: *603 examples: - default: *600 + default: *604 '404': *6 '500': *53 x-github: @@ -95068,8 +96690,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *331 + - *332 - name: ruleset_id description: The ID of the ruleset. in: path @@ -95089,9 +96711,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *314 examples: - default: *601 + default: *605 '404': *6 '500': *53 put: @@ -95109,8 +96731,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *331 + - *332 - name: ruleset_id description: The ID of the ruleset. in: path @@ -95135,16 +96757,16 @@ paths: - branch - tag - push - enforcement: *286 + enforcement: *290 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *287 - conditions: *284 + items: *291 + conditions: *288 rules: description: An array of rules within the ruleset. type: array - items: *591 + items: *595 examples: default: value: @@ -95172,9 +96794,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *314 examples: - default: *601 + default: *605 '404': *6 '422': *15 '500': *53 @@ -95193,8 +96815,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *331 + - *332 - name: ruleset_id description: The ID of the ruleset. in: path @@ -95217,8 +96839,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 - name: ruleset_id @@ -95234,9 +96856,9 @@ paths: application/json: schema: type: array - items: *313 + items: *317 examples: - default: *602 + default: *606 '404': *6 '500': *53 x-github: @@ -95255,8 +96877,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *327 - - *328 + - *331 + - *332 - name: ruleset_id description: The ID of the ruleset. in: path @@ -95274,7 +96896,7 @@ paths: description: Response content: application/json: - schema: *603 + schema: *607 examples: default: value: @@ -95329,25 +96951,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *327 - - *328 - - *604 - - *605 - - *606 - - *607 + - *331 + - *332 - *608 - *609 - *610 - *611 - - *60 - - *19 - - *17 - *612 - *613 - *614 - *615 + - *60 + - *19 + - *17 - *616 - *617 + - *618 + - *619 + - *620 + - *621 responses: '200': description: Response @@ -95355,7 +96977,7 @@ paths: application/json: schema: type: array - items: &621 + items: &625 type: object properties: number: *171 @@ -95371,8 +96993,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *618 - resolution: *619 + state: *622 + resolution: *623 resolved_at: type: - string @@ -95478,7 +97100,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *620 + - *624 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -95637,16 +97259,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *327 - - *328 - - *424 - - *617 + - *331 + - *332 + - *428 + - *621 responses: '200': description: Response content: application/json: - schema: *621 + schema: *625 examples: default: value: @@ -95700,9 +97322,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *327 - - *328 - - *424 + - *331 + - *332 + - *428 requestBody: required: true content: @@ -95710,8 +97332,8 @@ paths: schema: type: object properties: - state: *618 - resolution: *619 + state: *622 + resolution: *623 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -95724,6 +97346,16 @@ paths: type: - string - 'null' + validity: + type: + - string + - 'null' + enum: + - active + - inactive + - + description: Sets the validity of the secret scanning alert. Can + be `active`, `inactive`, or `null` to clear the override. anyOf: - required: - state @@ -95749,7 +97381,7 @@ paths: description: Response content: application/json: - schema: *621 + schema: *625 examples: default: value: @@ -95821,7 +97453,8 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment, - or assignee does not have write access to the repository + assignee does not have write access to the repository, or the requested + validity change could not be applied to this alert '503': *114 x-github: enabledForGitHubApps: true @@ -95844,9 +97477,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *327 - - *328 - - *424 + - *331 + - *332 + - *428 - *19 - *17 responses: @@ -95857,7 +97490,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &770 + items: &775 type: object properties: type: @@ -95884,10 +97517,6 @@ paths: - commit details: oneOf: - - *622 - - *623 - - *624 - - *625 - *626 - *627 - *628 @@ -95897,6 +97526,10 @@ paths: - *632 - *633 - *634 + - *635 + - *636 + - *637 + - *638 examples: default: value: @@ -95982,8 +97615,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -95991,14 +97624,14 @@ paths: schema: type: object properties: - reason: &636 + reason: &640 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *635 + placeholder_id: *639 required: - reason - placeholder_id @@ -96015,7 +97648,7 @@ paths: schema: type: object properties: - reason: *636 + reason: *640 expire_at: type: - string @@ -96062,8 +97695,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -96078,7 +97711,7 @@ paths: properties: incremental_scans: type: array - items: &637 + items: &641 description: Information on a single scan performed by secret scanning on the repository type: object @@ -96106,15 +97739,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *637 + items: *641 backfill_scans: type: array - items: *637 + items: *641 custom_pattern_backfill_scans: type: array items: allOf: - - *637 + - *641 - type: object properties: pattern_name: @@ -96127,7 +97760,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *637 + items: *641 examples: default: value: @@ -96192,8 +97825,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *327 - - *328 + - *331 + - *332 - *60 - name: sort description: The property to sort the results by. @@ -96237,9 +97870,9 @@ paths: application/json: schema: type: array - items: *638 + items: *642 examples: - default: *639 + default: *643 '400': *14 '404': *6 x-github: @@ -96262,8 +97895,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -96343,7 +97976,7 @@ paths: login: type: string description: The username of the user credited. - type: *316 + type: *320 required: - login - type @@ -96433,9 +98066,9 @@ paths: description: Response content: application/json: - schema: *638 + schema: *642 examples: - default: &641 + default: &645 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -96668,8 +98301,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -96782,7 +98415,7 @@ paths: description: Response content: application/json: - schema: *638 + schema: *642 examples: default: value: @@ -96929,17 +98562,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *327 - - *328 - - *640 + - *331 + - *332 + - *644 responses: '200': description: Response content: application/json: - schema: *638 + schema: *642 examples: - default: *641 + default: *645 '403': *27 '404': *6 x-github: @@ -96963,9 +98596,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *327 - - *328 - - *640 + - *331 + - *332 + - *644 requestBody: required: true content: @@ -97045,7 +98678,7 @@ paths: login: type: string description: The username of the user credited. - type: *316 + type: *320 required: - login - type @@ -97136,10 +98769,10 @@ paths: description: Response content: application/json: - schema: *638 + schema: *642 examples: - default: *641 - add_credit: *641 + default: *645 + add_credit: *645 '403': *27 '404': *6 '422': @@ -97177,9 +98810,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *327 - - *328 - - *640 + - *331 + - *332 + - *644 responses: '202': *37 '400': *14 @@ -97206,17 +98839,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *327 - - *328 - - *640 + - *331 + - *332 + - *644 responses: '202': description: Response content: application/json: - schema: *330 + schema: *334 examples: - default: *332 + default: *336 '400': *14 '422': *15 '403': *27 @@ -97242,8 +98875,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -97339,8 +98972,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -97349,7 +98982,7 @@ paths: application/json: schema: type: array - items: &642 + items: &646 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -97382,8 +99015,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -97461,8 +99094,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -97556,8 +99189,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -97711,8 +99344,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -97722,7 +99355,7 @@ paths: application/json: schema: type: array - items: *642 + items: *646 examples: default: value: @@ -97755,8 +99388,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *327 - - *328 + - *331 + - *332 - name: sha in: path required: true @@ -97812,7 +99445,7 @@ paths: description: Response content: application/json: - schema: *643 + schema: *647 examples: default: value: @@ -97866,8 +99499,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -97899,14 +99532,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &644 + schema: &648 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -97979,8 +99612,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: false content: @@ -98006,7 +99639,7 @@ paths: description: Response content: application/json: - schema: *644 + schema: *648 examples: default: value: @@ -98033,8 +99666,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -98054,8 +99687,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -98137,8 +99770,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *327 - - *328 + - *331 + - *332 - name: ref in: path required: true @@ -98174,8 +99807,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -98185,9 +99818,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - default: *248 + default: *252 headers: Link: *66 '404': *6 @@ -98207,8 +99840,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *327 - - *328 + - *331 + - *332 - *19 - *17 responses: @@ -98216,7 +99849,7 @@ paths: description: Response content: application/json: - schema: &645 + schema: &649 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -98228,7 +99861,7 @@ paths: required: - names examples: - default: &646 + default: &650 value: names: - octocat @@ -98251,8 +99884,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -98283,9 +99916,9 @@ paths: description: Response content: application/json: - schema: *645 + schema: *649 examples: - default: *646 + default: *650 '404': *6 '422': *7 x-github: @@ -98306,9 +99939,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *327 - - *328 - - &647 + - *331 + - *332 + - &651 name: per description: The time frame to display results for. in: query @@ -98339,7 +99972,7 @@ paths: - 128 clones: type: array - items: &648 + items: &652 title: Traffic type: object properties: @@ -98426,8 +100059,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -98521,8 +100154,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -98585,9 +100218,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *327 - - *328 - - *647 + - *331 + - *332 + - *651 responses: '200': description: Response @@ -98608,7 +100241,7 @@ paths: - 3782 views: type: array - items: *648 + items: *652 required: - uniques - count @@ -98685,8 +100318,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -98960,8 +100593,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -98984,8 +100617,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -99007,8 +100640,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -99034,8 +100667,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *327 - - *328 + - *331 + - *332 - name: ref in: path required: true @@ -99127,9 +100760,9 @@ paths: description: Response content: application/json: - schema: *330 + schema: *334 examples: - default: *332 + default: *336 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -99381,7 +101014,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &649 + text_matches: &653 title: Search Result Text Matches type: array items: @@ -99544,7 +101177,7 @@ paths: enum: - author-date - committer-date - - &650 + - &654 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -99613,7 +101246,7 @@ paths: committer: anyOf: - type: 'null' - - *392 + - *396 comment_count: type: integer message: @@ -99632,7 +101265,7 @@ paths: url: type: string format: uri - verification: *511 + verification: *515 required: - author - committer @@ -99647,7 +101280,7 @@ paths: committer: anyOf: - type: 'null' - - *392 + - *396 parents: type: array items: @@ -99664,7 +101297,7 @@ paths: type: number node_id: type: string - text_matches: *649 + text_matches: *653 required: - sha - node_id @@ -99856,7 +101489,7 @@ paths: - interactions - created - updated - - *650 + - *654 - *17 - *19 - name: advanced_search @@ -99970,11 +101603,11 @@ paths: type: - string - 'null' - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: type: string state_reason: @@ -99988,7 +101621,7 @@ paths: milestone: anyOf: - type: 'null' - - *268 + - *272 comments: type: integer created_at: @@ -100002,7 +101635,7 @@ paths: - string - 'null' format: date-time - text_matches: *649 + text_matches: *653 pull_request: type: object properties: @@ -100051,7 +101684,7 @@ paths: timeline_url: type: string format: uri - type: *232 + type: *236 performed_via_github_app: anyOf: - type: 'null' @@ -100268,7 +101901,7 @@ paths: enum: - created - updated - - *650 + - *654 - *17 - *19 responses: @@ -100313,7 +101946,7 @@ paths: - 'null' score: type: number - text_matches: *649 + text_matches: *653 required: - id - node_id @@ -100398,7 +102031,7 @@ paths: - forks - help-wanted-issues - updated - - *650 + - *654 - *17 - *19 responses: @@ -100644,7 +102277,7 @@ paths: - admin - pull - push - text_matches: *649 + text_matches: *653 temp_clone_token: type: string allow_merge_commit: @@ -100952,7 +102585,7 @@ paths: - string - 'null' format: uri - text_matches: *649 + text_matches: *653 related: type: - array @@ -101145,7 +102778,7 @@ paths: - followers - repositories - joined - - *650 + - *654 - *17 - *19 responses: @@ -101255,7 +102888,7 @@ paths: type: - boolean - 'null' - text_matches: *649 + text_matches: *653 blog: type: - string @@ -101337,7 +102970,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &653 + - &657 name: team_id description: The unique identifier of the team. in: path @@ -101349,9 +102982,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '404': *6 x-github: githubCloudOnly: false @@ -101378,7 +103011,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *653 + - *657 requestBody: required: true content: @@ -101442,16 +103075,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '201': description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '404': *6 '422': *15 '403': *27 @@ -101479,7 +103112,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *653 + - *657 responses: '204': description: Response @@ -101508,7 +103141,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *653 + - *657 - *17 - *19 responses: @@ -101518,9 +103151,9 @@ paths: application/json: schema: type: array - items: *226 + items: *230 examples: - default: *227 + default: *231 headers: Link: *66 x-github: @@ -101546,7 +103179,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *653 + - *657 - name: role description: Filters members returned by their role in the team. in: query @@ -101597,7 +103230,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *653 + - *657 - *70 responses: '204': @@ -101634,7 +103267,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *653 + - *657 - *70 responses: '204': @@ -101674,7 +103307,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *653 + - *657 - *70 responses: '204': @@ -101711,16 +103344,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *653 + - *657 - *70 responses: '200': description: Response content: application/json: - schema: *326 + schema: *330 examples: - response-if-user-is-a-team-maintainer: *654 + response-if-user-is-a-team-maintainer: *658 '404': *6 x-github: githubCloudOnly: false @@ -101753,7 +103386,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *653 + - *657 - *70 requestBody: required: false @@ -101779,9 +103412,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *330 examples: - response-if-users-membership-with-team-is-now-pending: *655 + response-if-users-membership-with-team-is-now-pending: *659 '403': description: Forbidden if team synchronization is set up '422': @@ -101815,7 +103448,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *653 + - *657 - *70 responses: '204': @@ -101843,7 +103476,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *653 + - *657 - *17 - *19 responses: @@ -101855,7 +103488,7 @@ paths: type: array items: *153 examples: - default: *255 + default: *259 headers: Link: *66 '404': *6 @@ -101885,15 +103518,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *653 - - *327 - - *328 + - *657 + - *331 + - *332 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *656 + schema: *660 examples: alternative-response-with-extra-repository-information: value: @@ -102044,9 +103677,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *653 - - *327 - - *328 + - *657 + - *331 + - *332 requestBody: required: false content: @@ -102096,9 +103729,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *653 - - *327 - - *328 + - *657 + - *331 + - *332 responses: '204': description: Response @@ -102123,7 +103756,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *653 + - *657 - *17 - *19 responses: @@ -102133,9 +103766,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - response-if-child-teams-exist: *657 + response-if-child-teams-exist: *661 headers: Link: *66 '404': *6 @@ -102168,7 +103801,7 @@ paths: application/json: schema: oneOf: - - &659 + - &663 title: Private User description: Private User type: object @@ -102418,7 +104051,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *658 + - *662 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -102578,7 +104211,7 @@ paths: description: Response content: application/json: - schema: *659 + schema: *663 examples: default: value: @@ -102781,9 +104414,9 @@ paths: type: integer codespaces: type: array - items: *237 + items: *241 examples: - default: *238 + default: *242 '304': *35 '500': *53 '401': *23 @@ -102922,17 +104555,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '401': *23 '403': *27 '404': *6 @@ -102976,7 +104609,7 @@ paths: type: integer secrets: type: array - items: &660 + items: &664 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -103018,7 +104651,7 @@ paths: - visibility - selected_repositories_url examples: - default: *449 + default: *453 headers: Link: *66 x-github: @@ -103096,7 +104729,7 @@ paths: description: Response content: application/json: - schema: *660 + schema: *664 examples: default: value: @@ -103242,7 +104875,7 @@ paths: type: array items: *153 examples: - default: *188 + default: *192 '401': *23 '403': *27 '404': *6 @@ -103386,15 +105019,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *239 + - *243 responses: '200': description: Response content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '304': *35 '500': *53 '401': *23 @@ -103420,7 +105053,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *239 + - *243 requestBody: required: false content: @@ -103450,9 +105083,9 @@ paths: description: Response content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '401': *23 '403': *27 '404': *6 @@ -103474,7 +105107,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *239 + - *243 responses: '202': *37 '304': *35 @@ -103503,13 +105136,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *239 + - *243 responses: '202': description: Response content: application/json: - schema: &661 + schema: &665 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -103562,7 +105195,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &662 + default: &666 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -103594,7 +105227,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *239 + - *243 - name: export_id in: path required: true @@ -103607,9 +105240,9 @@ paths: description: Response content: application/json: - schema: *661 + schema: *665 examples: - default: *662 + default: *666 '404': *6 x-github: githubCloudOnly: false @@ -103630,7 +105263,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *239 + - *243 responses: '200': description: Response @@ -103646,9 +105279,9 @@ paths: type: integer machines: type: array - items: *448 + items: *452 examples: - default: *663 + default: *667 '304': *35 '500': *53 '401': *23 @@ -103677,7 +105310,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *239 + - *243 requestBody: required: true content: @@ -103733,11 +105366,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *330 + repository: *334 machine: anyOf: - type: 'null' - - *448 + - *452 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -104534,15 +106167,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *239 + - *243 responses: '200': description: Response content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '304': *35 '500': *53 '400': *14 @@ -104574,15 +106207,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *239 + - *243 responses: '200': description: Response content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '500': *53 '401': *23 '403': *27 @@ -104612,9 +106245,9 @@ paths: application/json: schema: type: array - items: *249 + items: *253 examples: - default: &674 + default: &678 value: - id: 197 name: hello_docker @@ -104715,7 +106348,7 @@ paths: application/json: schema: type: array - items: &664 + items: &668 title: Email description: Email type: object @@ -104785,9 +106418,9 @@ paths: application/json: schema: type: array - items: *664 + items: *668 examples: - default: &676 + default: &680 value: - email: octocat@github.com verified: true @@ -104864,7 +106497,7 @@ paths: application/json: schema: type: array - items: *664 + items: *668 examples: default: value: @@ -105122,7 +106755,7 @@ paths: application/json: schema: type: array - items: &665 + items: &669 title: GPG Key description: A unique encryption key type: object @@ -105267,7 +106900,7 @@ paths: - subkeys - revoked examples: - default: &692 + default: &697 value: - id: 3 name: Octocat's GPG Key @@ -105352,9 +106985,9 @@ paths: description: Response content: application/json: - schema: *665 + schema: *669 examples: - default: &666 + default: &670 value: id: 3 name: Octocat's GPG Key @@ -105411,7 +107044,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &667 + - &671 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -105423,9 +107056,9 @@ paths: description: Response content: application/json: - schema: *665 + schema: *669 examples: - default: *666 + default: *670 '404': *6 '304': *35 '403': *27 @@ -105448,7 +107081,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *667 + - *671 responses: '204': description: Response @@ -105727,12 +107360,12 @@ paths: application/json: schema: anyOf: - - *224 + - *228 - type: object properties: {} additionalProperties: false examples: - default: *225 + default: *229 '204': description: Response when there are no restrictions x-github: @@ -105756,7 +107389,7 @@ paths: required: true content: application/json: - schema: *522 + schema: *526 examples: default: value: @@ -105767,7 +107400,7 @@ paths: description: Response content: application/json: - schema: *224 + schema: *228 examples: default: value: @@ -105848,7 +107481,7 @@ paths: - closed - all default: open - - *235 + - *239 - name: sort description: What to sort results by. in: query @@ -105873,7 +107506,7 @@ paths: type: array items: *82 examples: - default: *236 + default: *240 headers: Link: *66 '404': *6 @@ -105906,7 +107539,7 @@ paths: application/json: schema: type: array - items: &668 + items: &672 title: Key description: Key type: object @@ -106009,9 +107642,9 @@ paths: description: Response content: application/json: - schema: *668 + schema: *672 examples: - default: &669 + default: &673 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -106044,15 +107677,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *553 + - *557 responses: '200': description: Response content: application/json: - schema: *668 + schema: *672 examples: - default: *669 + default: *673 '404': *6 '304': *35 '403': *27 @@ -106075,7 +107708,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *553 + - *557 responses: '204': description: Response @@ -106108,7 +107741,7 @@ paths: application/json: schema: type: array - items: &670 + items: &674 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -106187,7 +107820,7 @@ paths: - account - plan examples: - default: &671 + default: &675 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -106249,9 +107882,9 @@ paths: application/json: schema: type: array - items: *670 + items: *674 examples: - default: *671 + default: *675 headers: Link: *66 '304': *35 @@ -106291,7 +107924,7 @@ paths: application/json: schema: type: array - items: *241 + items: *245 examples: default: value: @@ -106405,7 +108038,7 @@ paths: description: Response content: application/json: - schema: *241 + schema: *245 examples: default: value: @@ -106492,7 +108125,7 @@ paths: description: Response content: application/json: - schema: *241 + schema: *245 examples: default: value: @@ -106564,7 +108197,7 @@ paths: application/json: schema: type: array - items: *243 + items: *247 examples: default: value: @@ -106826,7 +108459,7 @@ paths: description: Response content: application/json: - schema: *243 + schema: *247 examples: default: value: @@ -107006,7 +108639,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *244 + - *248 - name: exclude in: query required: false @@ -107019,7 +108652,7 @@ paths: description: Response content: application/json: - schema: *243 + schema: *247 examples: default: value: @@ -107213,7 +108846,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *244 + - *248 responses: '302': description: Response @@ -107239,7 +108872,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *244 + - *248 responses: '204': description: Response @@ -107268,8 +108901,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *244 - - *672 + - *248 + - *676 responses: '204': description: Response @@ -107293,7 +108926,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *244 + - *248 - *17 - *19 responses: @@ -107305,7 +108938,7 @@ paths: type: array items: *153 examples: - default: *255 + default: *259 headers: Link: *66 '404': *6 @@ -107384,7 +109017,7 @@ paths: - docker - nuget - container - - *673 + - *677 - *19 - *17 responses: @@ -107394,10 +109027,10 @@ paths: application/json: schema: type: array - items: *249 + items: *253 examples: - default: *674 - '400': *675 + default: *678 + '400': *679 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107417,16 +109050,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *251 - - *252 + - *255 + - *256 responses: '200': description: Response content: application/json: - schema: *249 + schema: *253 examples: - default: &693 + default: &698 value: id: 40201 name: octo-name @@ -107539,8 +109172,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *251 - - *252 + - *255 + - *256 responses: '204': description: Response @@ -107570,8 +109203,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *251 - - *252 + - *255 + - *256 - name: token description: package token schema: @@ -107603,8 +109236,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *251 - - *252 + - *255 + - *256 - *19 - *17 - name: state @@ -107624,7 +109257,7 @@ paths: application/json: schema: type: array - items: *253 + items: *257 examples: default: value: @@ -107673,15 +109306,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *251 - - *252 - - *254 + - *255 + - *256 + - *258 responses: '200': description: Response content: application/json: - schema: *253 + schema: *257 examples: default: value: @@ -107717,9 +109350,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *251 - - *252 - - *254 + - *255 + - *256 + - *258 responses: '204': description: Response @@ -107749,9 +109382,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *251 - - *252 - - *254 + - *255 + - *256 + - *258 responses: '204': description: Response @@ -107788,9 +109421,9 @@ paths: application/json: schema: type: array - items: *664 + items: *668 examples: - default: *676 + default: *680 headers: Link: *66 '304': *35 @@ -107903,7 +109536,7 @@ paths: type: array items: *78 examples: - default: &683 + default: &687 summary: Default response value: - id: 1296269 @@ -108221,9 +109854,9 @@ paths: description: Response content: application/json: - schema: *330 + schema: *334 examples: - default: *332 + default: *336 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -108261,9 +109894,9 @@ paths: application/json: schema: type: array - items: *524 + items: *528 examples: - default: *677 + default: *681 headers: Link: *66 '304': *35 @@ -108286,7 +109919,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *228 + - *232 responses: '204': description: Response @@ -108309,7 +109942,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *228 + - *232 responses: '204': description: Response @@ -108342,7 +109975,7 @@ paths: application/json: schema: type: array - items: &678 + items: &682 title: Social account description: Social media account type: object @@ -108359,7 +109992,7 @@ paths: - provider - url examples: - default: &679 + default: &683 value: - provider: twitter url: https://twitter.com/github @@ -108422,9 +110055,9 @@ paths: application/json: schema: type: array - items: *678 + items: *682 examples: - default: *679 + default: *683 '422': *15 '304': *35 '404': *6 @@ -108512,7 +110145,7 @@ paths: application/json: schema: type: array - items: &680 + items: &684 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -108532,7 +110165,7 @@ paths: - title - created_at examples: - default: &711 + default: &716 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -108597,9 +110230,9 @@ paths: description: Response content: application/json: - schema: *680 + schema: *684 examples: - default: &681 + default: &685 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -108629,7 +110262,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &682 + - &686 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -108641,9 +110274,9 @@ paths: description: Response content: application/json: - schema: *680 + schema: *684 examples: - default: *681 + default: *685 '404': *6 '304': *35 '403': *27 @@ -108666,7 +110299,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *682 + - *686 responses: '204': description: Response @@ -108695,7 +110328,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &712 + - &717 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -108720,11 +110353,11 @@ paths: type: array items: *78 examples: - default-response: *683 + default-response: *687 application/vnd.github.v3.star+json: schema: type: array - items: &713 + items: &718 title: Starred Repository description: Starred Repository type: object @@ -108880,8 +110513,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response if this repository is starred by you @@ -108909,8 +110542,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -108934,8 +110567,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -108970,7 +110603,7 @@ paths: type: array items: *153 examples: - default: *255 + default: *259 headers: Link: *66 '304': *35 @@ -109007,7 +110640,7 @@ paths: application/json: schema: type: array - items: *323 + items: *327 examples: default: value: @@ -109093,10 +110726,10 @@ paths: application/json: schema: oneOf: - - *659 - - *658 + - *663 + - *662 examples: - default-response: &687 + default-response: &691 summary: Default response value: login: octocat @@ -109131,7 +110764,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &688 + response-with-git-hub-plan-information: &692 summary: Response with GitHub plan information value: login: octocat @@ -109188,14 +110821,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &685 + - &689 name: user_id description: The unique identifier of the user. in: path required: true schema: type: string - - *267 + - *271 requestBody: required: true description: Details of the draft item to create in the project. @@ -109229,9 +110862,9 @@ paths: description: Response content: application/json: - schema: *272 + schema: *276 examples: - draft_issue: *273 + draft_issue: *277 '304': *35 '403': *27 '401': *23 @@ -109254,7 +110887,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *684 + - *688 - *17 responses: '200': @@ -109289,8 +110922,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *685 - - *267 + - *689 + - *271 requestBody: required: true content: @@ -109364,17 +110997,17 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *686 + schema: *690 examples: table_view: summary: Response for creating a table view - value: *277 + value: *281 board_view: summary: Response for creating a board view with filter - value: *277 + value: *281 roadmap_view: summary: Response for creating a roadmap view - value: *277 + value: *281 '304': *35 '403': *27 '401': *23 @@ -109416,11 +111049,11 @@ paths: application/json: schema: oneOf: - - *659 - - *658 + - *663 + - *662 examples: - default-response: *687 - response-with-git-hub-plan-information: *688 + default-response: *691 + response-with-git-hub-plan-information: *692 '404': *6 x-github: githubCloudOnly: false @@ -109470,8 +111103,8 @@ paths: required: - subject_digests examples: - default: *689 - withPredicateType: *690 + default: *693 + withPredicateType: *694 responses: '200': description: Response @@ -109525,7 +111158,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *691 + default: *695 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109730,7 +111363,7 @@ paths: initiator: type: string examples: - default: *388 + default: *392 '201': description: Response content: @@ -109747,6 +111380,1244 @@ paths: enabledForGitHubApps: true category: users subcategory: attestations + "/users/{username}/copilot-spaces": + get: + summary: List Copilot Spaces for a user + description: |- + Lists Copilot Spaces owned by a user. The authenticated user must have read access to the user's Copilot Spaces. + + Only Spaces that are readable by the authenticated user are returned. This includes the user's own spaces, and public user spaces when accessing another user's spaces. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-copilot-spaces-for-a-user + parameters: + - *70 + - name: per_page + description: The number of results per page (max 100). + in: query + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: before + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + in: query + schema: + type: string + - name: after + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. + in: query + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - spaces + properties: + spaces: + type: array + description: The list of Copilot Spaces on this page of results. + items: *187 + examples: + default: + summary: Example response for listing user copilot spaces + value: + spaces: + - id: 42 + number: 1 + name: Personal Research Space + description: My personal space for research and development + owner: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-16T10:15:00Z' + updated_at: '2023-02-16T16:30:00Z' + html_url: https://github.com/copilot/spaces/octocat/1 + api_url: https://api.github.com/user/1/copilot-spaces/1 + - id: 43 + number: 2 + name: Learning Space + description: Space for learning new technologies + owner: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-17T08:20:00Z' + updated_at: '2023-02-17T14:45:00Z' + html_url: https://github.com/copilot/spaces/octocat/2 + api_url: https://api.github.com/user/1/copilot-spaces/2 + headers: + Link: *66 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + post: + summary: Create a Copilot Space for a user + description: |- + Creates a new Copilot Space owned by a user. Only the authenticated user can create spaces for their own account. + + Users can create personal Copilot Spaces for their individual use. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-a-copilot-space-for-a-user + parameters: + - *70 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - My Development Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Personal space for development assistance + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Help me with React development patterns and best practices + base_role: + type: string + enum: + - reader + - no_access + description: |- + The base role that determines default permissions for the space. + - `no_access`: No default access (default) + - `reader`: Makes the space publicly readable + Note: User spaces do not support writer or admin base roles. + default: no_access + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + required: + - name + examples: + default: + value: + name: My Development Space + description: Personal space for development assistance + general_instructions: Help me with React development patterns and + best practices + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 789012 + file_path: src/components/App.js + - resource_type: free_text + metadata: + name: Development Notes + text: Focus on clean code principles and modern React patterns + responses: + '201': + description: Response + content: + application/json: + schema: *187 + examples: + default: &696 + summary: Example response for a user copilot space + value: + id: 42 + number: 5 + name: My Development Space + description: Personal space for React development patterns + general_instructions: Focus on React functional components, hooks, + and modern development patterns + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-15T08:30:00Z' + updated_at: '2023-02-15T14:45:00Z' + html_url: https://github.com/copilot/spaces/octocat/5 + api_url: https://api.github.com/user/1/copilot-spaces/5 + base_role: no_access + resources_attributes: + - id: 789 + resource_type: github_file + metadata: + repository_id: 1234 + file_path: src/components/App.tsx + - id: 790 + resource_type: free_text + metadata: + name: React Best Practices + text: Use functional components with hooks + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + "/users/{username}/copilot-spaces/{space_number}": + get: + summary: Get a Copilot Space for a user + description: |- + Gets details about a specific Copilot Space owned by a user. The authenticated user must have read access to the Space. + + Private user spaces require the authenticated user to be the owner of the space. + Public user spaces are accessible to any authenticated user. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *187 + examples: + default: *696 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + put: + summary: Set a Copilot Space for a user + description: |- + Updates a Copilot Space owned by a user. Only the authenticated user can update spaces for their own account. + + Users can update their personal Copilot Spaces. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - Updated Development Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Updated personal space for development assistance + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Updated instructions to help me with React development patterns + and best practices + base_role: + type: string + enum: + - reader + - no_access + description: |- + The base role that determines default permissions for the space. Changing this field requires admin permissions. + - `no_access`: No default access (default) + - `reader`: Makes the space publicly readable + Note: User spaces do not support writer or admin base roles. + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + examples: + default: + value: + name: Updated Development Space + description: Updated personal space for development assistance + general_instructions: Updated instructions to help me with React + development patterns and best practices + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 789012 + file_path: src/components/UpdatedApp.js + - id: 123 + _destroy: true + - id: 456 + resource_type: free_text + metadata: + name: Updated Development Notes + text: Updated focus on clean code principles and modern React + patterns + responses: + '200': + description: Response + content: + application/json: + schema: *187 + examples: + default: *696 + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + delete: + summary: Delete a Copilot Space for a user + description: |- + Deletes a Copilot Space owned by a user. The authenticated user must be the owner of the space. + + **Warning:** This action is permanent and cannot be undone. Deleting a space will remove all associated resources and configurations. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '204': + description: The Copilot Space has been successfully deleted. + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + "/users/{username}/copilot-spaces/{space_number}/collaborators": + get: + summary: List collaborators for a Copilot Space for a user + description: |- + Lists all collaborators for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + Each collaborator entry specifies which user has access to the space and at what level (reader, writer, or admin). The space owner is excluded from this list. + + Team collaborators are not supported for user-owned Copilot Spaces. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-collaborators-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - collaborators + properties: + collaborators: + type: array + description: The list of collaborators for this Copilot Space. + items: *189 + examples: + default: + value: + collaborators: + - actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + - actor_type: User + role: reader + login: github-user + id: 67890 + node_id: MDQ6VXNlcjY3ODkw + avatar_url: https://github.com/images/error/other_user.gif + gravatar_id: '' + url: https://api.github.com/users/github-user + html_url: https://github.com/github-user + followers_url: https://api.github.com/users/github-user/followers + following_url: https://api.github.com/users/github-user/following{/other_user} + gists_url: https://api.github.com/users/github-user/gists{/gist_id} + starred_url: https://api.github.com/users/github-user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github-user/subscriptions + organizations_url: https://api.github.com/users/github-user/orgs + repos_url: https://api.github.com/users/github-user/repos + events_url: https://api.github.com/users/github-user/events{/privacy} + received_events_url: https://api.github.com/users/github-user/received_events + type: User + user_view_type: public + site_admin: false + name: GitHub User + company: + blog: '' + location: + email: + hireable: + bio: + twitter_username: + public_repos: 5 + public_gists: 0 + followers: 10 + following: 5 + created_at: '2010-01-14T04:33:35Z' + updated_at: '2010-01-14T04:33:35Z' + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + post: + summary: Add a collaborator to a Copilot Space for a user + description: |- + Adds a collaborator to a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + Team collaborators are not supported for user-owned Copilot Spaces. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/add-collaborator-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - actor_type + - actor_identifier + - role + properties: + actor_type: + type: string + enum: + - User + - Team + description: The type of actor (must be `User` for user-owned spaces; + `Team` will be rejected). + actor_identifier: + type: string + description: The username of the collaborator. The numeric user + ID is also accepted. + role: + type: string + enum: + - reader + - writer + - admin + description: The role to grant to the collaborator. + examples: + default: + value: + actor_type: User + actor_identifier: octocat + role: writer + responses: + '201': + description: Response + content: + application/json: + schema: *189 + examples: + default: + value: + actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": + put: + summary: Set a collaborator role for a Copilot Space for a user + description: |- + Updates the role of a collaborator for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-collaborator-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (must be `User` for user-owned spaces; `Team` + will be rejected). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username of the collaborator. The numeric user ID is also + accepted. + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - role + properties: + role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: The new role to grant to the collaborator. Use `no_access` + to remove the collaborator. + examples: + default: + value: + role: admin + responses: + '200': + description: Response + content: + application/json: + schema: *189 + examples: + default: + value: + actor_type: User + role: admin + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + '204': + description: Response when `role` is `no_access` and the collaborator was + removed. + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + delete: + summary: Remove a collaborator from a Copilot Space for a user + description: |- + Removes a collaborator from a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/remove-collaborator-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (must be `User` for user-owned spaces; `Team` + will be rejected). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username of the collaborator. The numeric user ID is also + accepted. + in: path + required: true + schema: + type: string + responses: + '204': + description: Response + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + "/users/{username}/copilot-spaces/{space_number}/resources": + get: + summary: List resources for a Copilot Space for a user + description: |- + Lists all resources attached to a specific Copilot Space owned by a user. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-resources-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - resources + properties: + resources: + type: array + description: The list of resources attached to this Copilot Space. + items: *190 + examples: + default: + value: + resources: + - id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + post: + summary: Create a resource for a Copilot Space for a user + description: |- + Creates a new resource in a specific Copilot Space owned by a user. + The authenticated user must have write permissions on the space. + + The following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`. + The `uploaded_text_file` and `media_content` types are not supported via this endpoint. + + For `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status. + + OAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - resource_type + - metadata + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + description: The type of resource to create. + metadata: + type: object + description: Resource-specific metadata. + additionalProperties: true + examples: + free_text: + value: + resource_type: free_text + metadata: + name: notes.txt + text: Some helpful notes + repository: + value: + resource_type: repository + metadata: + repository_id: 42 + github_file: + value: + resource_type: github_file + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + responses: + '201': + description: Resource created + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '200': + description: Duplicate github_file resource already exists + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: github_file + copilot_chat_attachment_id: + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}": + get: + summary: Get a resource for a Copilot Space for a user + description: |- + Gets a specific resource attached to a Copilot Space owned by a user. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + put: + summary: Set a resource for a Copilot Space for a user + description: |- + Updates the metadata of a resource in a specific Copilot Space owned by a user. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + description: Updated resource-specific metadata. + additionalProperties: true + examples: + default: + value: + metadata: + name: updated-notes.txt + text: Updated content + responses: + '200': + description: Response + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: updated-notes.txt + text: Updated content + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T12:00:00Z' + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + delete: + summary: Delete a resource from a Copilot Space for a user + description: |- + Deletes a resource from a specific Copilot Space owned by a user. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources "/users/{username}/docker/conflicts": get: summary: Get list of conflicting packages during Docker migration for user @@ -109769,9 +112640,9 @@ paths: application/json: schema: type: array - items: *249 + items: *253 examples: - default: *674 + default: *678 '403': *27 '401': *23 x-github: @@ -110155,9 +113026,9 @@ paths: application/json: schema: type: array - items: *665 + items: *669 examples: - default: *692 + default: *697 headers: Link: *66 x-github: @@ -110261,7 +113132,7 @@ paths: application/json: schema: *20 examples: - default: *521 + default: *525 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -110386,7 +113257,7 @@ paths: - docker - nuget - container - - *673 + - *677 - *70 - *19 - *17 @@ -110397,12 +113268,12 @@ paths: application/json: schema: type: array - items: *249 + items: *253 examples: - default: *674 + default: *678 '403': *27 '401': *23 - '400': *675 + '400': *679 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -110422,17 +113293,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *251 - - *252 + - *255 + - *256 - *70 responses: '200': description: Response content: application/json: - schema: *249 + schema: *253 examples: - default: *693 + default: *698 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -110453,8 +113324,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *251 - - *252 + - *255 + - *256 - *70 responses: '204': @@ -110487,8 +113358,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *251 - - *252 + - *255 + - *256 - *70 - name: token description: package token @@ -110521,8 +113392,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *251 - - *252 + - *255 + - *256 - *70 responses: '200': @@ -110531,7 +113402,7 @@ paths: application/json: schema: type: array - items: *253 + items: *257 examples: default: value: @@ -110589,16 +113460,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *251 - - *252 - - *254 + - *255 + - *256 + - *258 - *70 responses: '200': description: Response content: application/json: - schema: *253 + schema: *257 examples: default: value: @@ -110633,10 +113504,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *251 - - *252 + - *255 + - *256 - *70 - - *254 + - *258 responses: '204': description: Response @@ -110668,10 +113539,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *251 - - *252 + - *255 + - *256 - *70 - - *254 + - *258 responses: '204': description: Response @@ -110712,9 +113583,9 @@ paths: application/json: schema: type: array - items: *265 + items: *269 examples: - default: *266 + default: *270 headers: Link: *66 '304': *35 @@ -110736,16 +113607,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-user parameters: - - *267 + - *271 - *70 responses: '200': description: Response content: application/json: - schema: *265 + schema: *269 examples: - default: *266 + default: *270 headers: Link: *66 '304': *35 @@ -110767,7 +113638,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user parameters: - - *267 + - *271 - *70 - *17 - *45 @@ -110779,9 +113650,9 @@ paths: application/json: schema: type: array - items: *270 + items: *274 examples: - default: *694 + default: *699 headers: Link: *66 '304': *35 @@ -110803,7 +113674,7 @@ paths: url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project parameters: - *70 - - *267 + - *271 requestBody: required: true content: @@ -110841,7 +113712,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *695 + items: *700 required: - name - data_type @@ -110857,7 +113728,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *696 + iteration_configuration: *701 required: - name - data_type @@ -110879,20 +113750,20 @@ paths: value: name: Due date data_type: date - single_select_field: *697 - iteration_field: *698 + single_select_field: *702 + iteration_field: *703 responses: '201': description: Response content: application/json: - schema: *270 + schema: *274 examples: - text_field: *699 - number_field: *700 - date_field: *701 - single_select_field: *702 - iteration_field: *703 + text_field: *704 + number_field: *705 + date_field: *706 + single_select_field: *707 + iteration_field: *708 '304': *35 '403': *27 '401': *23 @@ -110913,17 +113784,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - - *267 - - *704 + - *271 + - *709 - *70 responses: '200': description: Response content: application/json: - schema: *270 + schema: *274 examples: - default: *705 + default: *710 headers: Link: *66 '304': *35 @@ -110946,7 +113817,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project parameters: - - *267 + - *271 - *70 - *45 - *46 @@ -110979,9 +113850,9 @@ paths: application/json: schema: type: array - items: *274 + items: *278 examples: - default: *275 + default: *279 headers: Link: *66 '304': *35 @@ -111003,7 +113874,7 @@ paths: url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project parameters: - *70 - - *267 + - *271 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -111073,22 +113944,22 @@ paths: description: Response content: application/json: - schema: *272 + schema: *276 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *273 + value: *277 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *273 + value: *277 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *273 + value: *277 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *273 + value: *277 '304': *35 '403': *27 '401': *23 @@ -111108,9 +113979,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *267 + - *271 - *70 - - *276 + - *280 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -111130,9 +114001,9 @@ paths: description: Response content: application/json: - schema: *274 + schema: *278 examples: - default: *275 + default: *279 headers: Link: *66 '304': *35 @@ -111153,9 +114024,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-user parameters: - - *267 + - *271 - *70 - - *276 + - *280 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -111228,13 +114099,13 @@ paths: description: Response content: application/json: - schema: *274 + schema: *278 examples: - text_field: *275 - number_field: *275 - date_field: *275 - single_select_field: *275 - iteration_field: *275 + text_field: *279 + number_field: *279 + date_field: *279 + single_select_field: *279 + iteration_field: *279 '401': *23 '403': *27 '404': *6 @@ -111254,9 +114125,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-user parameters: - - *267 + - *271 - *70 - - *276 + - *280 responses: '204': description: Response @@ -111278,9 +114149,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-project-view parameters: - - *267 + - *271 - *70 - - *706 + - *711 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -111306,9 +114177,9 @@ paths: application/json: schema: type: array - items: *274 + items: *278 examples: - default: *275 + default: *279 headers: Link: *66 '304': *35 @@ -111529,7 +114400,7 @@ paths: type: array items: *153 examples: - default: *255 + default: *259 headers: Link: *66 x-github: @@ -111555,7 +114426,7 @@ paths: - *116 - *118 - *117 - - *707 + - *712 - *119 responses: '200': @@ -111686,7 +114557,7 @@ paths: parameters: - *70 - *116 - - *708 + - *713 - *117 responses: '200': @@ -111785,9 +114656,9 @@ paths: - *116 - *118 - *117 - - *709 + - *714 - *119 - - *710 + - *715 responses: '200': description: Response when getting a billing usage summary @@ -111921,9 +114792,9 @@ paths: application/json: schema: type: array - items: *678 + items: *682 examples: - default: *679 + default: *683 headers: Link: *66 x-github: @@ -111953,9 +114824,9 @@ paths: application/json: schema: type: array - items: *680 + items: *684 examples: - default: *711 + default: *716 headers: Link: *66 x-github: @@ -111980,7 +114851,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *70 - - *712 + - *717 - *60 - *17 - *19 @@ -111992,11 +114863,11 @@ paths: schema: anyOf: - type: array - items: *713 + items: *718 - type: array items: *78 examples: - default-response: *683 + default-response: *687 headers: Link: *66 x-github: @@ -112027,7 +114898,7 @@ paths: type: array items: *153 examples: - default: *255 + default: *259 headers: Link: *66 x-github: @@ -112156,7 +115027,7 @@ webhooks: type: string enum: - disabled - enterprise: &714 + enterprise: &719 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -112225,7 +115096,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &715 + installation: &720 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -112246,7 +115117,7 @@ webhooks: required: - id - node_id - organization: &716 + organization: &721 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -112319,7 +115190,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &717 + repository: &722 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -113245,10 +116116,10 @@ webhooks: type: string enum: - enabled - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -113324,11 +116195,11 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - rule: &718 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + rule: &723 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -113551,11 +116422,11 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - rule: *718 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + rule: *723 sender: *4 required: - action @@ -113743,11 +116614,11 @@ webhooks: - everyone required: - from - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - rule: *718 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + rule: *723 sender: *4 required: - action @@ -113831,7 +116702,7 @@ webhooks: type: string enum: - completed - check_run: &720 + check_run: &725 title: CheckRun description: A check performed on the code of a given code change type: object @@ -113941,7 +116812,7 @@ webhooks: - examples: - neutral - deployment: *719 + deployment: *724 details_url: type: string examples: @@ -114039,10 +116910,10 @@ webhooks: - output - app - pull_requests - installation: *715 - enterprise: *714 - organization: *716 - repository: *717 + installation: *720 + enterprise: *719 + organization: *721 + repository: *722 sender: *4 required: - check_run @@ -114433,11 +117304,11 @@ webhooks: type: string enum: - created - check_run: *720 - installation: *715 - enterprise: *714 - organization: *716 - repository: *717 + check_run: *725 + installation: *720 + enterprise: *719 + organization: *721 + repository: *722 sender: *4 required: - check_run @@ -114831,11 +117702,11 @@ webhooks: type: string enum: - requested_action - check_run: *720 - installation: *715 - enterprise: *714 - organization: *716 - repository: *717 + check_run: *725 + installation: *720 + enterprise: *719 + organization: *721 + repository: *722 requested_action: description: The action requested by the user. type: object @@ -115238,11 +118109,11 @@ webhooks: type: string enum: - rerequested - check_run: *720 - installation: *715 - enterprise: *714 - organization: *716 - repository: *717 + check_run: *725 + installation: *720 + enterprise: *719 + organization: *721 + repository: *722 sender: *4 required: - check_run @@ -116227,10 +119098,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -116934,10 +119805,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -117635,10 +120506,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -117807,7 +120678,7 @@ webhooks: required: - login - id - dismissed_comment: *419 + dismissed_comment: *423 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -117959,20 +120830,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &721 + commit_oid: &726 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *714 - installation: *715 - organization: *716 - ref: &722 + enterprise: *719 + installation: *720 + organization: *721 + ref: &727 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *717 + repository: *722 sender: *4 required: - action @@ -118139,7 +121010,7 @@ webhooks: required: - login - id - dismissed_comment: *419 + dismissed_comment: *423 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -118380,12 +121251,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *721 - enterprise: *714 - installation: *715 - organization: *716 - ref: *722 - repository: *717 + commit_oid: *726 + enterprise: *719 + installation: *720 + organization: *721 + ref: *727 + repository: *722 sender: *4 required: - action @@ -118483,7 +121354,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *419 + dismissed_comment: *423 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -118668,12 +121539,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *721 - enterprise: *714 - installation: *715 - organization: *716 - ref: *722 - repository: *717 + commit_oid: *726 + enterprise: *719 + installation: *720 + organization: *721 + ref: *727 + repository: *722 sender: *4 required: - action @@ -118842,7 +121713,7 @@ webhooks: required: - login - id - dismissed_comment: *419 + dismissed_comment: *423 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -119019,12 +121890,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *721 - enterprise: *714 - installation: *715 - organization: *716 - ref: *722 - repository: *717 + commit_oid: *726 + enterprise: *719 + installation: *720 + organization: *721 + ref: *727 + repository: *722 sender: *4 required: - action @@ -119125,7 +121996,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *419 + dismissed_comment: *423 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -119314,9 +122185,9 @@ webhooks: type: - string - 'null' - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -119324,7 +122195,7 @@ webhooks: type: - string - 'null' - repository: *717 + repository: *722 sender: *4 required: - action @@ -119423,7 +122294,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *419 + dismissed_comment: *423 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -119570,12 +122441,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *721 - enterprise: *714 - installation: *715 - organization: *716 - ref: *722 - repository: *717 + commit_oid: *726 + enterprise: *719 + installation: *720 + organization: *721 + ref: *727 + repository: *722 sender: *4 required: - action @@ -119744,7 +122615,7 @@ webhooks: required: - login - id - dismissed_comment: *419 + dismissed_comment: *423 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -119896,10 +122767,10 @@ webhooks: - dismissed_reason - rule - tool - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -120159,10 +123030,10 @@ webhooks: - updated_at - author_association - body - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -120243,18 +123114,18 @@ webhooks: type: - string - 'null' - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *716 - pusher_type: &723 + organization: *721 + pusher_type: &728 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &724 + ref: &729 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -120264,7 +123135,7 @@ webhooks: enum: - tag - branch - repository: *717 + repository: *722 sender: *4 required: - ref @@ -120346,10 +123217,10 @@ webhooks: type: string enum: - created - definition: *278 - enterprise: *714 - installation: *715 - organization: *716 + definition: *282 + enterprise: *719 + installation: *720 + organization: *721 sender: *4 required: - action @@ -120434,9 +123305,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 sender: *4 required: - action @@ -120513,10 +123384,10 @@ webhooks: type: string enum: - promote_to_enterprise - definition: *278 - enterprise: *714 - installation: *715 - organization: *716 + definition: *282 + enterprise: *719 + installation: *720 + organization: *721 sender: *4 required: - action @@ -120593,10 +123464,10 @@ webhooks: type: string enum: - updated - definition: *278 - enterprise: *714 - installation: *715 - organization: *716 + definition: *282 + enterprise: *719 + installation: *720 + organization: *721 sender: *4 required: - action @@ -120673,19 +123544,19 @@ webhooks: type: string enum: - updated - enterprise: *714 - installation: *715 - repository: *717 - organization: *716 + enterprise: *719 + installation: *720 + repository: *722 + organization: *721 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *282 + items: *286 old_property_values: type: array description: The old custom property values for the repository. - items: *282 + items: *286 required: - action - repository @@ -120761,18 +123632,18 @@ webhooks: title: delete event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 - pusher_type: *723 - ref: *724 + enterprise: *719 + installation: *720 + organization: *721 + pusher_type: *728 + ref: *729 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *717 + repository: *722 sender: *4 required: - ref @@ -120852,11 +123723,11 @@ webhooks: type: string enum: - assignees_changed - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -120936,11 +123807,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -121021,11 +123892,11 @@ webhooks: type: string enum: - auto_reopened - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -121106,11 +123977,11 @@ webhooks: type: string enum: - created - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -121189,11 +124060,11 @@ webhooks: type: string enum: - dismissed - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -121272,11 +124143,11 @@ webhooks: type: string enum: - fixed - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -121356,11 +124227,11 @@ webhooks: type: string enum: - reintroduced - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -121439,11 +124310,11 @@ webhooks: type: string enum: - reopened - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -121520,9 +124391,9 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - key: &725 + enterprise: *719 + installation: *720 + key: &730 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -121560,8 +124431,8 @@ webhooks: - verified - created_at - read_only - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -121638,11 +124509,11 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - key: *725 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + key: *730 + organization: *721 + repository: *722 sender: *4 required: - action @@ -122209,12 +125080,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - workflow: &729 + workflow: &734 title: Workflow type: - object @@ -122965,13 +125836,13 @@ webhooks: deployment: anyOf: - type: 'null' - - *486 + - *490 pull_requests: type: array - items: *571 - repository: *717 - organization: *716 - installation: *715 + items: *575 + repository: *722 + organization: *721 + installation: *720 sender: *4 responses: '200': @@ -123042,7 +125913,7 @@ webhooks: type: string enum: - approved - approver: &726 + approver: &731 type: object properties: avatar_url: @@ -123085,11 +125956,11 @@ webhooks: type: string comment: type: string - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - reviewers: &727 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + reviewers: &732 type: array items: type: object @@ -123170,7 +126041,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &728 + workflow_job_run: &733 type: object properties: conclusion: @@ -123916,18 +126787,18 @@ webhooks: type: string enum: - rejected - approver: *726 + approver: *731 comment: type: string - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - reviewers: *727 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + reviewers: *732 sender: *4 since: type: string - workflow_job_run: *728 + workflow_job_run: *733 workflow_job_runs: type: array items: @@ -124644,13 +127515,13 @@ webhooks: type: string enum: - requested - enterprise: *714 + enterprise: *719 environment: type: string - installation: *715 - organization: *716 - repository: *717 - requestor: &734 + installation: *720 + organization: *721 + repository: *722 + requestor: &739 title: User type: - object @@ -126583,12 +129454,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - workflow: *729 + workflow: *734 workflow_run: title: Deployment Workflow Run type: @@ -127279,7 +130150,7 @@ webhooks: type: string enum: - answered - answer: &732 + answer: &737 type: object properties: author_association: @@ -127439,11 +130310,11 @@ webhooks: - created_at - updated_at - body - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -127570,11 +130441,11 @@ webhooks: - from required: - category - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -127657,11 +130528,11 @@ webhooks: type: string enum: - closed - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -127743,7 +130614,7 @@ webhooks: type: string enum: - created - comment: &731 + comment: &736 type: object properties: author_association: @@ -127903,11 +130774,11 @@ webhooks: - updated_at - body - reactions - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -127990,12 +130861,12 @@ webhooks: type: string enum: - deleted - comment: *731 - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + comment: *736 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128090,12 +130961,12 @@ webhooks: - from required: - body - comment: *731 - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + comment: *736 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128179,11 +131050,11 @@ webhooks: type: string enum: - created - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128265,11 +131136,11 @@ webhooks: type: string enum: - deleted - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128369,11 +131240,11 @@ webhooks: type: string required: - from - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128455,10 +131326,10 @@ webhooks: type: string enum: - labeled - discussion: *730 - enterprise: *714 - installation: *715 - label: &733 + discussion: *735 + enterprise: *719 + installation: *720 + label: &738 title: Label type: object properties: @@ -128491,8 +131362,8 @@ webhooks: - color - default - description - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128575,11 +131446,11 @@ webhooks: type: string enum: - locked - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128661,11 +131532,11 @@ webhooks: type: string enum: - pinned - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128747,11 +131618,11 @@ webhooks: type: string enum: - reopened - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128836,16 +131707,16 @@ webhooks: changes: type: object properties: - new_discussion: *730 - new_repository: *717 + new_discussion: *735 + new_repository: *722 required: - new_discussion - new_repository - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128928,10 +131799,10 @@ webhooks: type: string enum: - unanswered - discussion: *730 - old_answer: *732 - organization: *716 - repository: *717 + discussion: *735 + old_answer: *737 + organization: *721 + repository: *722 sender: *4 required: - action @@ -129013,12 +131884,12 @@ webhooks: type: string enum: - unlabeled - discussion: *730 - enterprise: *714 - installation: *715 - label: *733 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + label: *738 + organization: *721 + repository: *722 sender: *4 required: - action @@ -129101,11 +131972,11 @@ webhooks: type: string enum: - unlocked - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -129187,11 +132058,11 @@ webhooks: type: string enum: - unpinned - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -129264,7 +132135,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *714 + enterprise: *719 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -129942,9 +132813,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - forkee @@ -130090,9 +132961,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pages: description: The pages that were updated. type: array @@ -130130,7 +133001,7 @@ webhooks: - action - sha - html_url - repository: *717 + repository: *722 sender: *4 required: - pages @@ -130206,10 +133077,10 @@ webhooks: type: string enum: - created - enterprise: *714 + enterprise: *719 installation: *20 - organization: *716 - repositories: &735 + organization: *721 + repositories: &740 description: An array of repository objects that the installation can access. type: array @@ -130235,8 +133106,8 @@ webhooks: - name - full_name - private - repository: *717 - requester: *734 + repository: *722 + requester: *739 sender: *4 required: - action @@ -130311,11 +133182,11 @@ webhooks: type: string enum: - deleted - enterprise: *714 + enterprise: *719 installation: *20 - organization: *716 - repositories: *735 - repository: *717 + organization: *721 + repositories: *740 + repository: *722 requester: type: - 'null' @@ -130392,11 +133263,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *714 + enterprise: *719 installation: *20 - organization: *716 - repositories: *735 - repository: *717 + organization: *721 + repositories: *740 + repository: *722 requester: type: - 'null' @@ -130473,10 +133344,10 @@ webhooks: type: string enum: - added - enterprise: *714 + enterprise: *719 installation: *20 - organization: *716 - repositories_added: &736 + organization: *721 + repositories_added: &741 description: An array of repository objects, which were added to the installation. type: array @@ -130522,15 +133393,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *717 - repository_selection: &737 + repository: *722 + repository_selection: &742 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *734 + requester: *739 sender: *4 required: - action @@ -130609,10 +133480,10 @@ webhooks: type: string enum: - removed - enterprise: *714 + enterprise: *719 installation: *20 - organization: *716 - repositories_added: *736 + organization: *721 + repositories_added: *741 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -130639,9 +133510,9 @@ webhooks: - name - full_name - private - repository: *717 - repository_selection: *737 - requester: *734 + repository: *722 + repository_selection: *742 + requester: *739 sender: *4 required: - action @@ -130720,11 +133591,11 @@ webhooks: type: string enum: - suspend - enterprise: *714 + enterprise: *719 installation: *20 - organization: *716 - repositories: *735 - repository: *717 + organization: *721 + repositories: *740 + repository: *722 requester: type: - 'null' @@ -130906,10 +133777,10 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 target_type: type: string @@ -130988,11 +133859,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *714 + enterprise: *719 installation: *20 - organization: *716 - repositories: *735 - repository: *717 + organization: *721 + repositories: *740 + repository: *722 requester: type: - 'null' @@ -131158,7 +134029,7 @@ webhooks: pin: anyOf: - type: 'null' - - *550 + - *554 user: title: User type: @@ -131244,8 +134115,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -132057,8 +134928,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132075,7 +134946,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -132419,8 +135290,8 @@ webhooks: - state - locked - assignee - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -132500,7 +135371,7 @@ webhooks: type: string enum: - deleted - comment: &738 + comment: &743 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -132657,7 +135528,7 @@ webhooks: pin: anyOf: - type: 'null' - - *550 + - *554 required: - url - html_url @@ -132671,8 +135542,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -133480,8 +136351,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133498,7 +136369,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -133844,8 +136715,8 @@ webhooks: - state - locked - assignee - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -133925,7 +136796,7 @@ webhooks: type: string enum: - edited - changes: &762 + changes: &767 description: The changes to the comment. type: object properties: @@ -133937,9 +136808,9 @@ webhooks: type: string required: - from - comment: *738 - enterprise: *714 - installation: *715 + comment: *743 + enterprise: *719 + installation: *720 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -134750,8 +137621,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134768,7 +137639,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -135112,8 +137983,8 @@ webhooks: - state - locked - assignee - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -135194,9 +138065,9 @@ webhooks: type: string enum: - pinned - comment: *738 - enterprise: *714 - installation: *715 + comment: *743 + enterprise: *719 + installation: *720 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -136009,8 +138880,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136027,7 +138898,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -136373,8 +139244,8 @@ webhooks: - state - locked - assignee - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -136454,9 +139325,9 @@ webhooks: type: string enum: - unpinned - comment: *738 - enterprise: *714 - installation: *715 + comment: *743 + enterprise: *719 + installation: *720 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -137269,8 +140140,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137287,7 +140158,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -137633,8 +140504,8 @@ webhooks: - state - locked - assignee - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -137723,9 +140594,9 @@ webhooks: type: number blocking_issue: *82 blocking_issue_repo: *78 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -137814,9 +140685,9 @@ webhooks: type: number blocking_issue: *82 blocking_issue_repo: *78 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -137904,9 +140775,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -137995,9 +140866,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -138077,10 +140948,10 @@ webhooks: type: string enum: - assigned - assignee: *734 - enterprise: *714 - installation: *715 - issue: &739 + assignee: *739 + enterprise: *719 + installation: *720 + issue: &744 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -138891,11 +141762,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138912,7 +141783,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -139015,8 +141886,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -139096,8 +141967,8 @@ webhooks: type: string enum: - closed - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -139913,11 +142784,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139934,7 +142805,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -140180,8 +143051,8 @@ webhooks: required: - state - closed_at - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -140260,8 +143131,8 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141068,11 +143939,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141089,7 +143960,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -141191,8 +144062,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -141271,8 +144142,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -142102,11 +144973,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142123,7 +144994,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -142204,7 +145075,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &740 + milestone: &745 title: Milestone description: A collection of related issues and pull requests. type: object @@ -142347,8 +145218,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -142447,8 +145318,8 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -143259,11 +146130,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143277,7 +146148,7 @@ webhooks: timeline_url: type: string format: uri - type: *232 + type: *236 title: description: Title of the issue type: string @@ -143383,9 +146254,9 @@ webhooks: - active_lock_reason - body - reactions - label: *733 - organization: *716 - repository: *717 + label: *738 + organization: *721 + repository: *722 sender: *4 required: - action @@ -143465,9 +146336,9 @@ webhooks: type: string enum: - field_added - enterprise: *714 - installation: *715 - issue: *739 + enterprise: *719 + installation: *720 + issue: *744 issue_field: type: object description: The issue field whose value was set or updated on the @@ -143586,8 +146457,8 @@ webhooks: - id required: - from - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -143667,9 +146538,9 @@ webhooks: type: string enum: - field_removed - enterprise: *714 - installation: *715 - issue: *739 + enterprise: *719 + installation: *720 + issue: *744 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -143732,8 +146603,8 @@ webhooks: - 'null' required: - id - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -143813,8 +146684,8 @@ webhooks: type: string enum: - labeled - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144624,11 +147495,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144642,7 +147513,7 @@ webhooks: timeline_url: type: string format: uri - type: *232 + type: *236 title: description: Title of the issue type: string @@ -144748,9 +147619,9 @@ webhooks: - active_lock_reason - body - reactions - label: *733 - organization: *716 - repository: *717 + label: *738 + organization: *721 + repository: *722 sender: *4 required: - action @@ -144830,8 +147701,8 @@ webhooks: type: string enum: - locked - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -145666,11 +148537,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145684,7 +148555,7 @@ webhooks: timeline_url: type: string format: uri - type: *232 + type: *236 title: description: Title of the issue type: string @@ -145767,8 +148638,8 @@ webhooks: format: uri user_view_type: type: string - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -145847,8 +148718,8 @@ webhooks: type: string enum: - milestoned - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -146677,11 +149548,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146698,7 +149569,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -146778,9 +149649,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *740 - organization: *716 - repository: *717 + milestone: *745 + organization: *721 + repository: *722 sender: *4 required: - action @@ -147667,11 +150538,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147771,7 +150642,7 @@ webhooks: required: - login - id - type: *232 + type: *236 required: - id - number @@ -148263,8 +151134,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -149071,11 +151942,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149092,7 +151963,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -149198,8 +152069,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -149279,9 +152150,9 @@ webhooks: type: string enum: - pinned - enterprise: *714 - installation: *715 - issue: &741 + enterprise: *719 + installation: *720 + issue: &746 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -150086,11 +152957,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150107,7 +152978,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -150209,8 +153080,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -150289,8 +153160,8 @@ webhooks: type: string enum: - reopened - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -151123,11 +153994,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151224,9 +154095,9 @@ webhooks: format: uri user_view_type: type: string - type: *232 - organization: *716 - repository: *717 + type: *236 + organization: *721 + repository: *722 sender: *4 required: - action @@ -152114,11 +154985,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152135,7 +155006,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -152728,11 +155599,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *714 - installation: *715 - issue: *741 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + issue: *746 + organization: *721 + repository: *722 sender: *4 required: - action @@ -152812,12 +155683,12 @@ webhooks: type: string enum: - typed - enterprise: *714 - installation: *715 - issue: *739 - type: *232 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + issue: *744 + type: *236 + organization: *721 + repository: *722 sender: *4 required: - action @@ -152898,7 +155769,7 @@ webhooks: type: string enum: - unassigned - assignee: &765 + assignee: &770 title: User type: - object @@ -152970,11 +155841,11 @@ webhooks: required: - login - id - enterprise: *714 - installation: *715 - issue: *739 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + issue: *744 + organization: *721 + repository: *722 sender: *4 required: - action @@ -153053,12 +155924,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *714 - installation: *715 - issue: *739 - label: *733 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + issue: *744 + label: *738 + organization: *721 + repository: *722 sender: *4 required: - action @@ -153138,8 +156009,8 @@ webhooks: type: string enum: - unlocked - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -153972,11 +156843,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153993,7 +156864,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -154073,8 +156944,8 @@ webhooks: format: uri user_view_type: type: string - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -154154,11 +157025,11 @@ webhooks: type: string enum: - unpinned - enterprise: *714 - installation: *715 - issue: *741 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + issue: *746 + organization: *721 + repository: *722 sender: *4 required: - action @@ -154237,12 +157108,12 @@ webhooks: type: string enum: - untyped - enterprise: *714 - installation: *715 - issue: *739 - type: *232 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + issue: *744 + type: *236 + organization: *721 + repository: *722 sender: *4 required: - action @@ -154322,11 +157193,11 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - label: *733 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + label: *738 + organization: *721 + repository: *722 sender: *4 required: - action @@ -154404,11 +157275,11 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - label: *733 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + label: *738 + organization: *721 + repository: *722 sender: *4 required: - action @@ -154518,11 +157389,11 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - label: *733 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + label: *738 + organization: *721 + repository: *722 sender: *4 required: - action @@ -154604,9 +157475,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *714 - installation: *715 - marketplace_purchase: &742 + enterprise: *719 + installation: *720 + marketplace_purchase: &747 title: Marketplace Purchase type: object required: @@ -154694,8 +157565,8 @@ webhooks: type: integer unit_count: type: integer - organization: *716 - previous_marketplace_purchase: &743 + organization: *721 + previous_marketplace_purchase: &748 title: Marketplace Purchase type: object properties: @@ -154779,7 +157650,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *717 + repository: *722 sender: *4 required: - action @@ -154859,10 +157730,10 @@ webhooks: - changed effective_date: type: string - enterprise: *714 - installation: *715 - marketplace_purchase: *742 - organization: *716 + enterprise: *719 + installation: *720 + marketplace_purchase: *747 + organization: *721 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -154950,7 +157821,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *717 + repository: *722 sender: *4 required: - action @@ -155032,10 +157903,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *714 - installation: *715 - marketplace_purchase: *742 - organization: *716 + enterprise: *719 + installation: *720 + marketplace_purchase: *747 + organization: *721 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -155121,7 +157992,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *717 + repository: *722 sender: *4 required: - action @@ -155202,8 +158073,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 marketplace_purchase: title: Marketplace Purchase type: object @@ -155289,9 +158160,9 @@ webhooks: type: integer unit_count: type: integer - organization: *716 - previous_marketplace_purchase: *743 - repository: *717 + organization: *721 + previous_marketplace_purchase: *748 + repository: *722 sender: *4 required: - action @@ -155371,12 +158242,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *714 - installation: *715 - marketplace_purchase: *742 - organization: *716 - previous_marketplace_purchase: *743 - repository: *717 + enterprise: *719 + installation: *720 + marketplace_purchase: *747 + organization: *721 + previous_marketplace_purchase: *748 + repository: *722 sender: *4 required: - action @@ -155478,11 +158349,11 @@ webhooks: type: string required: - to - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + member: *739 + organization: *721 + repository: *722 sender: *4 required: - action @@ -155584,11 +158455,11 @@ webhooks: type: - string - 'null' - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + member: *739 + organization: *721 + repository: *722 sender: *4 required: - action @@ -155667,11 +158538,11 @@ webhooks: type: string enum: - removed - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + member: *739 + organization: *721 + repository: *722 sender: *4 required: - action @@ -155749,11 +158620,11 @@ webhooks: type: string enum: - added - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + member: *739 + organization: *721 + repository: *722 scope: description: The scope of the membership. Currently, can only be `team`. @@ -155831,7 +158702,7 @@ webhooks: required: - login - id - team: &744 + team: &749 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -156061,11 +158932,11 @@ webhooks: type: string enum: - removed - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + member: *739 + organization: *721 + repository: *722 scope: description: The scope of the membership. Currently, can only be `team`. @@ -156144,7 +159015,7 @@ webhooks: required: - login - id - team: *744 + team: *749 required: - action - scope @@ -156226,8 +159097,8 @@ webhooks: type: string enum: - checks_requested - installation: *715 - merge_group: &745 + installation: *720 + merge_group: &750 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -156246,15 +159117,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *408 + head_commit: *412 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -156340,10 +159211,10 @@ webhooks: - merged - invalidated - dequeued - installation: *715 - merge_group: *745 - organization: *716 - repository: *717 + installation: *720 + merge_group: *750 + organization: *721 + repository: *722 sender: *4 required: - action @@ -156416,7 +159287,7 @@ webhooks: type: string enum: - deleted - enterprise: *714 + enterprise: *719 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -156525,12 +159396,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *715 - organization: *716 + installation: *720 + organization: *721 repository: anyOf: - type: 'null' - - *717 + - *722 sender: *4 required: - action @@ -156610,11 +159481,11 @@ webhooks: type: string enum: - closed - enterprise: *714 - installation: *715 - milestone: *740 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + milestone: *745 + organization: *721 + repository: *722 sender: *4 required: - action @@ -156693,9 +159564,9 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - milestone: &746 + enterprise: *719 + installation: *720 + milestone: &751 title: Milestone description: A collection of related issues and pull requests. type: object @@ -156837,8 +159708,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -156917,11 +159788,11 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - milestone: *740 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + milestone: *745 + organization: *721 + repository: *722 sender: *4 required: - action @@ -157031,11 +159902,11 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - milestone: *740 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + milestone: *745 + organization: *721 + repository: *722 sender: *4 required: - action @@ -157115,11 +159986,11 @@ webhooks: type: string enum: - opened - enterprise: *714 - installation: *715 - milestone: *746 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + milestone: *751 + organization: *721 + repository: *722 sender: *4 required: - action @@ -157198,11 +160069,11 @@ webhooks: type: string enum: - blocked - blocked_user: *734 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + blocked_user: *739 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -157281,11 +160152,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *734 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + blocked_user: *739 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -157364,9 +160235,9 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - membership: &747 + enterprise: *719 + installation: *720 + membership: &752 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -157476,8 +160347,8 @@ webhooks: - role - organization_url - user - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -157555,11 +160426,11 @@ webhooks: type: string enum: - member_added - enterprise: *714 - installation: *715 - membership: *747 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + membership: *752 + organization: *721 + repository: *722 sender: *4 required: - action @@ -157638,8 +160509,8 @@ webhooks: type: string enum: - member_invited - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -157761,10 +160632,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 - user: *734 + user: *739 required: - action - invitation @@ -157842,11 +160713,11 @@ webhooks: type: string enum: - member_removed - enterprise: *714 - installation: *715 - membership: *747 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + membership: *752 + organization: *721 + repository: *722 sender: *4 required: - action @@ -157933,11 +160804,11 @@ webhooks: properties: from: type: string - enterprise: *714 - installation: *715 - membership: *747 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + membership: *752 + organization: *721 + repository: *722 sender: *4 required: - action @@ -158014,9 +160885,9 @@ webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 package: description: Information about the package. type: object @@ -158539,7 +161410,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &748 + items: &753 title: Ruby Gems metadata type: object properties: @@ -158636,7 +161507,7 @@ webhooks: - owner - package_version - registry - repository: *717 + repository: *722 sender: *4 required: - action @@ -158712,9 +161583,9 @@ webhooks: type: string enum: - updated - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 package: description: Information about the package. type: object @@ -159076,7 +161947,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *748 + items: *753 source_url: type: string format: uri @@ -159147,7 +162018,7 @@ webhooks: - owner - package_version - registry - repository: *717 + repository: *722 sender: *4 required: - action @@ -159327,12 +162198,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *714 + enterprise: *719 id: type: integer - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - id @@ -159409,7 +162280,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &749 + personal_access_token_request: &754 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -159559,10 +162430,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *714 - organization: *716 + enterprise: *719 + organization: *721 sender: *4 - installation: *715 + installation: *720 required: - action - personal_access_token_request @@ -159639,11 +162510,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *749 - enterprise: *714 - organization: *716 + personal_access_token_request: *754 + enterprise: *719 + organization: *721 sender: *4 - installation: *715 + installation: *720 required: - action - personal_access_token_request @@ -159719,11 +162590,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *749 - enterprise: *714 - organization: *716 + personal_access_token_request: *754 + enterprise: *719 + organization: *721 sender: *4 - installation: *715 + installation: *720 required: - action - personal_access_token_request @@ -159798,11 +162669,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *749 - organization: *716 - enterprise: *714 + personal_access_token_request: *754 + organization: *721 + enterprise: *719 sender: *4 - installation: *715 + installation: *720 required: - action - personal_access_token_request @@ -159907,7 +162778,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *750 + last_response: *755 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -159939,8 +162810,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 zen: description: Random string of GitHub zen. @@ -160185,10 +163056,10 @@ webhooks: - from required: - note - enterprise: *714 - installation: *715 - organization: *716 - project_card: &751 + enterprise: *719 + installation: *720 + organization: *721 + project_card: &756 title: Project Card type: object properties: @@ -160311,7 +163182,7 @@ webhooks: - creator - created_at - updated_at - repository: *717 + repository: *722 sender: *4 required: - action @@ -160392,11 +163263,11 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - project_card: *751 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + project_card: *756 + repository: *722 sender: *4 required: - action @@ -160476,9 +163347,9 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 project_card: title: Project Card type: object @@ -160608,7 +163479,7 @@ webhooks: repository: anyOf: - type: 'null' - - *717 + - *722 sender: *4 required: - action @@ -160702,11 +163573,11 @@ webhooks: - from required: - note - enterprise: *714 - installation: *715 - organization: *716 - project_card: *751 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + project_card: *756 + repository: *722 sender: *4 required: - action @@ -160800,9 +163671,9 @@ webhooks: - from required: - column_id - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 project_card: allOf: - title: Project Card @@ -160999,7 +163870,7 @@ webhooks: type: string required: - after_id - repository: *717 + repository: *722 sender: *4 required: - action @@ -161079,10 +163950,10 @@ webhooks: type: string enum: - closed - enterprise: *714 - installation: *715 - organization: *716 - project: &753 + enterprise: *719 + installation: *720 + organization: *721 + project: &758 title: Project type: object properties: @@ -161209,7 +164080,7 @@ webhooks: - creator - created_at - updated_at - repository: *717 + repository: *722 sender: *4 required: - action @@ -161289,10 +164160,10 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - project_column: &752 + enterprise: *719 + installation: *720 + organization: *721 + project_column: &757 title: Project Column type: object properties: @@ -161332,7 +164203,7 @@ webhooks: - name - created_at - updated_at - repository: *717 + repository: *722 sender: *4 required: - action @@ -161411,14 +164282,14 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - project_column: *752 + enterprise: *719 + installation: *720 + organization: *721 + project_column: *757 repository: anyOf: - type: 'null' - - *717 + - *722 sender: *4 required: - action @@ -161507,11 +164378,11 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 - project_column: *752 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + project_column: *757 + repository: *722 sender: *4 required: - action @@ -161591,11 +164462,11 @@ webhooks: type: string enum: - moved - enterprise: *714 - installation: *715 - organization: *716 - project_column: *752 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + project_column: *757 + repository: *722 sender: *4 required: - action @@ -161675,11 +164546,11 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - project: *753 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + project: *758 + repository: *722 sender: *4 required: - action @@ -161759,14 +164630,14 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - project: *753 + enterprise: *719 + installation: *720 + organization: *721 + project: *758 repository: anyOf: - type: 'null' - - *717 + - *722 sender: *4 required: - action @@ -161867,11 +164738,11 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 - project: *753 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + project: *758 + repository: *722 sender: *4 required: - action @@ -161950,11 +164821,11 @@ webhooks: type: string enum: - reopened - enterprise: *714 - installation: *715 - organization: *716 - project: *753 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + project: *758 + repository: *722 sender: *4 required: - action @@ -162035,9 +164906,9 @@ webhooks: type: string enum: - closed - installation: *715 - organization: *716 - projects_v2: *265 + installation: *720 + organization: *721 + projects_v2: *269 sender: *4 required: - action @@ -162118,9 +164989,9 @@ webhooks: type: string enum: - created - installation: *715 - organization: *716 - projects_v2: *265 + installation: *720 + organization: *721 + projects_v2: *269 sender: *4 required: - action @@ -162201,9 +165072,9 @@ webhooks: type: string enum: - deleted - installation: *715 - organization: *716 - projects_v2: *265 + installation: *720 + organization: *721 + projects_v2: *269 sender: *4 required: - action @@ -162324,9 +165195,9 @@ webhooks: type: string to: type: string - installation: *715 - organization: *716 - projects_v2: *265 + installation: *720 + organization: *721 + projects_v2: *269 sender: *4 required: - action @@ -162409,7 +165280,7 @@ webhooks: type: string enum: - archived - changes: &757 + changes: &762 type: object properties: archived_at: @@ -162425,9 +165296,9 @@ webhooks: - string - 'null' format: date-time - installation: *715 - organization: *716 - projects_v2_item: &754 + installation: *720 + organization: *721 + projects_v2_item: &759 title: Projects v2 Item description: An item belonging to a project type: object @@ -162445,7 +165316,7 @@ webhooks: type: string description: The node ID of the content represented by this item. - content_type: *271 + content_type: *275 creator: *4 created_at: type: string @@ -162567,9 +165438,9 @@ webhooks: - 'null' to: type: string - installation: *715 - organization: *716 - projects_v2_item: *754 + installation: *720 + organization: *721 + projects_v2_item: *759 sender: *4 required: - action @@ -162651,9 +165522,9 @@ webhooks: type: string enum: - created - installation: *715 - organization: *716 - projects_v2_item: *754 + installation: *720 + organization: *721 + projects_v2_item: *759 sender: *4 required: - action @@ -162734,9 +165605,9 @@ webhooks: type: string enum: - deleted - installation: *715 - organization: *716 - projects_v2_item: *754 + installation: *720 + organization: *721 + projects_v2_item: *759 sender: *4 required: - action @@ -162841,7 +165712,7 @@ webhooks: oneOf: - type: string - type: integer - - &755 + - &760 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -162865,7 +165736,7 @@ webhooks: required: - id - name - - &756 + - &761 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -162905,8 +165776,8 @@ webhooks: oneOf: - type: string - type: integer - - *755 - - *756 + - *760 + - *761 type: - 'null' - string @@ -162929,9 +165800,9 @@ webhooks: - 'null' required: - body - installation: *715 - organization: *716 - projects_v2_item: *754 + installation: *720 + organization: *721 + projects_v2_item: *759 sender: *4 required: - action @@ -163028,9 +165899,9 @@ webhooks: type: - string - 'null' - installation: *715 - organization: *716 - projects_v2_item: *754 + installation: *720 + organization: *721 + projects_v2_item: *759 sender: *4 required: - action @@ -163113,10 +165984,10 @@ webhooks: type: string enum: - restored - changes: *757 - installation: *715 - organization: *716 - projects_v2_item: *754 + changes: *762 + installation: *720 + organization: *721 + projects_v2_item: *759 sender: *4 required: - action @@ -163198,9 +166069,9 @@ webhooks: type: string enum: - reopened - installation: *715 - organization: *716 - projects_v2: *265 + installation: *720 + organization: *721 + projects_v2: *269 sender: *4 required: - action @@ -163281,9 +166152,9 @@ webhooks: type: string enum: - created - installation: *715 - organization: *716 - projects_v2_status_update: *758 + installation: *720 + organization: *721 + projects_v2_status_update: *763 sender: *4 required: - action @@ -163364,9 +166235,9 @@ webhooks: type: string enum: - deleted - installation: *715 - organization: *716 - projects_v2_status_update: *758 + installation: *720 + organization: *721 + projects_v2_status_update: *763 sender: *4 required: - action @@ -163512,9 +166383,9 @@ webhooks: - string - 'null' format: date - installation: *715 - organization: *716 - projects_v2_status_update: *758 + installation: *720 + organization: *721 + projects_v2_status_update: *763 sender: *4 required: - action @@ -163585,10 +166456,10 @@ webhooks: title: public event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - repository @@ -163665,13 +166536,13 @@ webhooks: type: string enum: - assigned - assignee: *734 - enterprise: *714 - installation: *715 - number: &759 + assignee: *739 + enterprise: *719 + installation: *720 + number: &764 description: The pull request number. type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -166042,7 +168913,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -166124,11 +168995,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -168492,7 +171363,7 @@ webhooks: - draft reason: type: string - repository: *717 + repository: *722 sender: *4 required: - action @@ -168574,11 +171445,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -170942,7 +173813,7 @@ webhooks: - draft reason: type: string - repository: *717 + repository: *722 sender: *4 required: - action @@ -171024,13 +173895,13 @@ webhooks: type: string enum: - closed - enterprise: *714 - installation: *715 - number: *759 - organization: *716 - pull_request: &760 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 + pull_request: &765 allOf: - - *571 + - *575 - type: object properties: allow_auto_merge: @@ -171092,7 +173963,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *717 + repository: *722 sender: *4 required: - action @@ -171173,12 +174044,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *714 - installation: *715 - number: *759 - organization: *716 - pull_request: *760 - repository: *717 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 + pull_request: *765 + repository: *722 sender: *4 required: - action @@ -171258,11 +174129,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *714 - milestone: *268 - number: *759 - organization: *716 - pull_request: &761 + enterprise: *719 + milestone: *272 + number: *764 + organization: *721 + pull_request: &766 title: Pull Request type: object properties: @@ -173611,7 +176482,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -173690,11 +176561,11 @@ webhooks: type: string enum: - dequeued - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -176062,7 +178933,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *717 + repository: *722 sender: *4 required: - action @@ -176186,12 +179057,12 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - number: *759 - organization: *716 - pull_request: *760 - repository: *717 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 + pull_request: *765 + repository: *722 sender: *4 required: - action @@ -176271,11 +179142,11 @@ webhooks: type: string enum: - enqueued - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -178628,7 +181499,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -178708,11 +181579,11 @@ webhooks: type: string enum: - labeled - enterprise: *714 - installation: *715 - label: *733 - number: *759 - organization: *716 + enterprise: *719 + installation: *720 + label: *738 + number: *764 + organization: *721 pull_request: title: Pull Request type: object @@ -181082,7 +183953,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -181163,10 +184034,10 @@ webhooks: type: string enum: - locked - enterprise: *714 - installation: *715 - number: *759 - organization: *716 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 pull_request: title: Pull Request type: object @@ -183534,7 +186405,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -183614,12 +186485,12 @@ webhooks: type: string enum: - milestoned - enterprise: *714 - milestone: *268 - number: *759 - organization: *716 - pull_request: *761 - repository: *717 + enterprise: *719 + milestone: *272 + number: *764 + organization: *721 + pull_request: *766 + repository: *722 sender: *4 required: - action @@ -183698,12 +186569,12 @@ webhooks: type: string enum: - opened - enterprise: *714 - installation: *715 - number: *759 - organization: *716 - pull_request: *760 - repository: *717 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 + pull_request: *765 + repository: *722 sender: *4 required: - action @@ -183784,12 +186655,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *714 - installation: *715 - number: *759 - organization: *716 - pull_request: *760 - repository: *717 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 + pull_request: *765 + repository: *722 sender: *4 required: - action @@ -183869,12 +186740,12 @@ webhooks: type: string enum: - reopened - enterprise: *714 - installation: *715 - number: *759 - organization: *716 - pull_request: *760 - repository: *717 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 + pull_request: *765 + repository: *722 sender: *4 required: - action @@ -184249,9 +187120,9 @@ webhooks: - start_side - side - reactions - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pull_request: type: object properties: @@ -186503,7 +189374,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *717 + repository: *722 sender: *4 required: - action @@ -186583,7 +189454,7 @@ webhooks: type: string enum: - deleted - comment: &763 + comment: &768 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -186876,9 +189747,9 @@ webhooks: - start_side - side - reactions - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pull_request: type: object properties: @@ -189118,7 +191989,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *717 + repository: *722 sender: *4 required: - action @@ -189198,11 +192069,11 @@ webhooks: type: string enum: - edited - changes: *762 - comment: *763 - enterprise: *714 - installation: *715 - organization: *716 + changes: *767 + comment: *768 + enterprise: *719 + installation: *720 + organization: *721 pull_request: type: object properties: @@ -191445,7 +194316,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *717 + repository: *722 sender: *4 required: - action @@ -191526,9 +194397,9 @@ webhooks: type: string enum: - dismissed - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pull_request: title: Simple Pull Request type: object @@ -193783,7 +196654,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 + repository: *722 review: description: The review that was affected. type: object @@ -194034,9 +196905,9 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pull_request: title: Simple Pull Request type: object @@ -196150,8 +199021,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 - review: &764 + repository: *722 + review: &769 description: The review that was affected. type: object properties: @@ -196389,12 +199260,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: description: The pull request number. type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -198763,7 +201634,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 requested_reviewer: title: User type: @@ -198849,12 +201720,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: description: The pull request number. type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -201230,7 +204101,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 requested_team: title: Team description: Groups of organization members that gives permissions @@ -201425,12 +204296,12 @@ webhooks: type: string enum: - review_requested - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: description: The pull request number. type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -203801,7 +206672,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 requested_reviewer: title: User type: @@ -203888,12 +206759,12 @@ webhooks: type: string enum: - review_requested - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: description: The pull request number. type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -206255,7 +209126,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 requested_team: title: Team description: Groups of organization members that gives permissions @@ -206439,9 +209310,9 @@ webhooks: type: string enum: - submitted - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pull_request: title: Simple Pull Request type: object @@ -208699,8 +211570,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 - review: *764 + repository: *722 + review: *769 sender: *4 required: - action @@ -208780,9 +211651,9 @@ webhooks: type: string enum: - resolved - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pull_request: title: Simple Pull Request type: object @@ -210935,7 +213806,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 + repository: *722 sender: *4 thread: type: object @@ -211332,9 +214203,9 @@ webhooks: type: string enum: - unresolved - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pull_request: title: Simple Pull Request type: object @@ -213470,7 +216341,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 + repository: *722 sender: *4 thread: type: object @@ -213869,10 +216740,10 @@ webhooks: type: string before: type: string - enterprise: *714 - installation: *715 - number: *759 - organization: *716 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 pull_request: title: Pull Request type: object @@ -216229,7 +219100,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -216311,11 +219182,11 @@ webhooks: type: string enum: - unassigned - assignee: *765 - enterprise: *714 - installation: *715 - number: *759 - organization: *716 + assignee: *770 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 pull_request: title: Pull Request type: object @@ -218687,7 +221558,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -218766,11 +221637,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *714 - installation: *715 - label: *733 - number: *759 - organization: *716 + enterprise: *719 + installation: *720 + label: *738 + number: *764 + organization: *721 pull_request: title: Pull Request type: object @@ -221131,7 +224002,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -221212,10 +224083,10 @@ webhooks: type: string enum: - unlocked - enterprise: *714 - installation: *715 - number: *759 - organization: *716 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 pull_request: title: Pull Request type: object @@ -223566,7 +226437,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -223769,7 +226640,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *714 + enterprise: *719 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -223864,8 +226735,8 @@ webhooks: - url - author - committer - installation: *715 - organization: *716 + installation: *720 + organization: *721 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -224464,9 +227335,9 @@ webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 registry_package: type: object properties: @@ -224943,7 +227814,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *748 + items: *753 summary: type: string tag_name: @@ -224999,7 +227870,7 @@ webhooks: - owner - package_version - registry - repository: *717 + repository: *722 sender: *4 required: - action @@ -225077,9 +227948,9 @@ webhooks: type: string enum: - updated - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 registry_package: type: object properties: @@ -225391,7 +228262,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *748 + items: *753 summary: type: string tag_name: @@ -225441,7 +228312,7 @@ webhooks: - owner - package_version - registry - repository: *717 + repository: *722 sender: *4 required: - action @@ -225518,10 +228389,10 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - release: &766 + enterprise: *719 + installation: *720 + organization: *721 + release: &771 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -225852,7 +228723,7 @@ webhooks: - updated_at - zipball_url - body - repository: *717 + repository: *722 sender: *4 required: - action @@ -225929,11 +228800,11 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - release: *766 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + release: *771 + repository: *722 sender: *4 required: - action @@ -226050,11 +228921,11 @@ webhooks: type: boolean required: - to - enterprise: *714 - installation: *715 - organization: *716 - release: *766 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + release: *771 + repository: *722 sender: *4 required: - action @@ -226132,9 +229003,9 @@ webhooks: type: string enum: - prereleased - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -226470,7 +229341,7 @@ webhooks: - string - 'null' format: uri - repository: *717 + repository: *722 sender: *4 required: - action @@ -226546,10 +229417,10 @@ webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 - release: &767 + enterprise: *719 + installation: *720 + organization: *721 + release: &772 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -226882,7 +229753,7 @@ webhooks: - string - 'null' format: uri - repository: *717 + repository: *722 sender: *4 required: - action @@ -226958,11 +229829,11 @@ webhooks: type: string enum: - released - enterprise: *714 - installation: *715 - organization: *716 - release: *766 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + release: *771 + repository: *722 sender: *4 required: - action @@ -227038,11 +229909,11 @@ webhooks: type: string enum: - unpublished - enterprise: *714 - installation: *715 - organization: *716 - release: *767 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + release: *772 + repository: *722 sender: *4 required: - action @@ -227118,11 +229989,11 @@ webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - repository_advisory: *638 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + repository_advisory: *642 sender: *4 required: - action @@ -227198,11 +230069,11 @@ webhooks: type: string enum: - reported - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - repository_advisory: *638 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + repository_advisory: *642 sender: *4 required: - action @@ -227278,10 +230149,10 @@ webhooks: type: string enum: - archived - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -227358,10 +230229,10 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -227439,10 +230310,10 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -227527,10 +230398,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -227645,10 +230516,10 @@ webhooks: - 'null' items: type: string - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -227720,10 +230591,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 status: type: string @@ -227804,10 +230675,10 @@ webhooks: type: string enum: - privatized - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -227884,10 +230755,10 @@ webhooks: type: string enum: - publicized - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -227981,10 +230852,10 @@ webhooks: - name required: - repository - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -228064,11 +230935,11 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - repository_ruleset: *310 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + repository_ruleset: *314 sender: *4 required: - action @@ -228146,11 +231017,11 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - repository_ruleset: *310 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + repository_ruleset: *314 sender: *4 required: - action @@ -228228,11 +231099,11 @@ webhooks: type: string enum: - edited - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - repository_ruleset: *310 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + repository_ruleset: *314 changes: type: object properties: @@ -228251,16 +231122,16 @@ webhooks: properties: added: type: array - items: *284 + items: *288 deleted: type: array - items: *284 + items: *288 updated: type: array items: type: object properties: - condition: *284 + condition: *288 changes: type: object properties: @@ -228293,16 +231164,16 @@ webhooks: properties: added: type: array - items: *591 + items: *595 deleted: type: array - items: *591 + items: *595 updated: type: array items: type: object properties: - rule: *591 + rule: *595 changes: type: object properties: @@ -228539,10 +231410,10 @@ webhooks: - from required: - owner - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -228620,10 +231491,10 @@ webhooks: type: string enum: - unarchived - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -228701,7 +231572,7 @@ webhooks: type: string enum: - create - alert: &768 + alert: &773 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -228826,10 +231697,10 @@ webhooks: enum: - auto_dismissed - open - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -229039,10 +231910,10 @@ webhooks: type: string enum: - dismissed - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -229120,11 +231991,11 @@ webhooks: type: string enum: - reopen - alert: *768 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *773 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -229326,10 +232197,10 @@ webhooks: enum: - fixed - open - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -229407,7 +232278,7 @@ webhooks: type: string enum: - assigned - alert: &769 + alert: &774 type: object properties: number: *171 @@ -229547,10 +232418,10 @@ webhooks: - type: 'null' - *4 assignee: *4 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -229628,11 +232499,11 @@ webhooks: type: string enum: - created - alert: *769 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *774 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -229713,11 +232584,11 @@ webhooks: type: string enum: - created - alert: *769 - installation: *715 - location: *770 - organization: *716 - repository: *717 + alert: *774 + installation: *720 + location: *775 + organization: *721 + repository: *722 sender: *4 required: - location @@ -229955,11 +232826,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *769 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *774 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -230037,11 +232908,11 @@ webhooks: type: string enum: - reopened - alert: *769 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *774 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -230119,11 +232990,11 @@ webhooks: type: string enum: - resolved - alert: *769 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *774 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -230201,12 +233072,12 @@ webhooks: type: string enum: - unassigned - alert: *769 + alert: *774 assignee: *4 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -230284,11 +233155,11 @@ webhooks: type: string enum: - validated - alert: *769 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *774 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -230418,10 +233289,10 @@ webhooks: - organization - enterprise - - repository: *717 - enterprise: *714 - installation: *715 - organization: *716 + repository: *722 + enterprise: *719 + installation: *720 + organization: *721 sender: *4 required: - action @@ -230499,11 +233370,11 @@ webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - security_advisory: &771 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + security_advisory: &776 description: The details of the security advisory, including summary, description, and severity. type: object @@ -230689,11 +233560,11 @@ webhooks: type: string enum: - updated - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - security_advisory: *771 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + security_advisory: *776 sender: *4 required: - action @@ -230766,10 +233637,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -230955,11 +233826,11 @@ webhooks: from: type: object properties: - security_and_analysis: *283 - enterprise: *714 - installation: *715 - organization: *716 - repository: *330 + security_and_analysis: *287 + enterprise: *719 + installation: *720 + organization: *721 + repository: *334 sender: *4 required: - changes @@ -231037,12 +233908,12 @@ webhooks: type: string enum: - cancelled - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - sponsorship: &772 + sponsorship: &777 type: object properties: created_at: @@ -231347,12 +234218,12 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - sponsorship: *772 + sponsorship: *777 required: - action - sponsorship @@ -231440,12 +234311,12 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - sponsorship: *772 + sponsorship: *777 required: - action - changes @@ -231522,17 +234393,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &773 + effective_date: &778 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - sponsorship: *772 + sponsorship: *777 required: - action - sponsorship @@ -231606,7 +234477,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &774 + changes: &779 type: object properties: tier: @@ -231650,13 +234521,13 @@ webhooks: - from required: - tier - effective_date: *773 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + effective_date: *778 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - sponsorship: *772 + sponsorship: *777 required: - action - changes @@ -231733,13 +234604,13 @@ webhooks: type: string enum: - tier_changed - changes: *774 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + changes: *779 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - sponsorship: *772 + sponsorship: *777 required: - action - changes @@ -231813,10 +234684,10 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -231900,10 +234771,10 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -232337,15 +235208,15 @@ webhooks: type: - string - 'null' - enterprise: *714 + enterprise: *719 id: description: The unique identifier of the status. type: integer - installation: *715 + installation: *720 name: type: string - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 sha: description: The Commit SHA. @@ -232461,9 +235332,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -232553,9 +235424,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -232645,9 +235516,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -232737,9 +235608,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -232816,12 +235687,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - team: &775 + team: &780 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -233051,9 +235922,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 repository: title: Repository description: A git repository @@ -233523,7 +236394,7 @@ webhooks: - topics - visibility sender: *4 - team: *775 + team: *780 required: - action - team @@ -233599,9 +236470,9 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 repository: title: Repository description: A git repository @@ -234071,7 +236942,7 @@ webhooks: - topics - visibility sender: *4 - team: *775 + team: *780 required: - action - team @@ -234148,9 +237019,9 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 repository: title: Repository description: A git repository @@ -234620,7 +237491,7 @@ webhooks: - topics - visibility sender: *4 - team: *775 + team: *780 required: - action - team @@ -234764,9 +237635,9 @@ webhooks: - from required: - permissions - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 repository: title: Repository description: A git repository @@ -235236,7 +238107,7 @@ webhooks: - topics - visibility sender: *4 - team: *775 + team: *780 required: - action - changes @@ -235314,9 +238185,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 repository: title: Repository description: A git repository @@ -235786,7 +238657,7 @@ webhooks: - topics - visibility sender: *4 - team: *775 + team: *780 required: - action - team @@ -235862,10 +238733,10 @@ webhooks: type: string enum: - started - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -235938,17 +238809,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *714 + enterprise: *719 inputs: type: - object - 'null' additionalProperties: true - installation: *715 - organization: *716 + installation: *720 + organization: *721 ref: type: string - repository: *717 + repository: *722 sender: *4 workflow: type: string @@ -236030,10 +238901,10 @@ webhooks: type: string enum: - completed - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 workflow_job: allOf: @@ -236289,7 +239160,7 @@ webhooks: type: string required: - conclusion - deployment: *486 + deployment: *490 required: - action - repository @@ -236368,10 +239239,10 @@ webhooks: type: string enum: - in_progress - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 workflow_job: allOf: @@ -236653,7 +239524,7 @@ webhooks: required: - status - steps - deployment: *486 + deployment: *490 required: - action - repository @@ -236732,10 +239603,10 @@ webhooks: type: string enum: - queued - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 workflow_job: type: object @@ -236881,7 +239752,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *486 + deployment: *490 required: - action - repository @@ -236960,10 +239831,10 @@ webhooks: type: string enum: - waiting - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 workflow_job: type: object @@ -237110,7 +239981,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *486 + deployment: *490 required: - action - repository @@ -237190,12 +240061,12 @@ webhooks: type: string enum: - completed - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - workflow: *729 + workflow: *734 workflow_run: title: Workflow Run type: object @@ -238214,12 +241085,12 @@ webhooks: type: string enum: - in_progress - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - workflow: *729 + workflow: *734 workflow_run: title: Workflow Run type: object @@ -239223,12 +242094,12 @@ webhooks: type: string enum: - requested - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - workflow: *729 + workflow: *734 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index 5acad8e7fd..7280796426 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -136,6 +136,10 @@ "name": "users", "description": "Interact with and view information about users and also current user." }, + { + "name": "code-quality", + "description": "Insights into reliability, maintainability, and efficiency of your codebase." + }, { "name": "codespaces", "description": "Endpoints to manage Codespaces using the REST API." @@ -144,6 +148,10 @@ "name": "copilot", "description": "Endpoints to manage Copilot using the REST API." }, + { + "name": "copilot-spaces", + "description": "Endpoints to manage Copilot Spaces using the REST API." + }, { "name": "security-advisories", "description": "Manage security advisories." @@ -5636,7 +5644,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -6776,7 +6784,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7689,7 +7697,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -8167,7 +8175,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -10503,7 +10511,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -11675,7 +11683,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -12711,7 +12719,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -13450,7 +13458,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -24643,7 +24651,7 @@ "/enterprises/{enterprise}/copilot/policies/coding_agent": { "put": { "summary": "Set the coding agent policy for an enterprise", - "description": "Sets the policy for Copilot coding agent usage across an enterprise.\n\nEnterprise owners can configure whether Copilot coding agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.\n\nOnly enterprise owners can set the coding agent policy for their enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "description": "Sets the policy for Copilot cloud agent usage across an enterprise.\n\nEnterprise owners can configure whether Copilot cloud agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.\n\nOnly enterprise owners can set the coding agent policy for their enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -24673,7 +24681,7 @@ "properties": { "policy_state": { "type": "string", - "description": "The policy state for Copilot coding agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.", + "description": "The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.", "enum": [ "enabled_for_all_orgs", "disabled_for_all_orgs", @@ -24780,7 +24788,7 @@ "/enterprises/{enterprise}/copilot/policies/coding_agent/organizations": { "post": { "summary": "Add organizations to the enterprise coding agent policy", - "description": "Enables Copilot coding agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can add organizations to the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "description": "Enables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can add organizations to the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -24801,7 +24809,7 @@ } ], "requestBody": { - "description": "The organizations to enable Copilot coding agent for", + "description": "The organizations to enable Copilot cloud agent for", "required": true, "content": { "application/json": { @@ -24810,7 +24818,7 @@ "properties": { "organizations": { "type": "array", - "description": "List of organization logins within the enterprise to enable Copilot coding agent for.", + "description": "List of organization logins within the enterprise to enable Copilot cloud agent for.", "items": { "type": "string" } @@ -24945,7 +24953,7 @@ }, "delete": { "summary": "Remove organizations from the enterprise coding agent policy", - "description": "Disables Copilot coding agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can remove organizations from the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "description": "Disables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can remove organizations from the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -24966,7 +24974,7 @@ } ], "requestBody": { - "description": "The organizations to disable Copilot coding agent for", + "description": "The organizations to disable Copilot cloud agent for", "required": true, "content": { "application/json": { @@ -24975,7 +24983,7 @@ "properties": { "organizations": { "type": "array", - "description": "List of organization logins within the enterprise to disable Copilot coding agent for.", + "description": "List of organization logins within the enterprise to disable Copilot cloud agent for.", "items": { "type": "string" } @@ -87337,6 +87345,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } }, "required": [ @@ -87400,6 +87412,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } } }, @@ -120264,17 +120280,17 @@ } } }, - "/orgs/{org}/copilot/billing": { + "/orgs/{org}/copilot-spaces": { "get": { - "summary": "Get Copilot seat information and settings for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "summary": "List organization Copilot Spaces", + "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/get-copilot-organization-details", + "operationId": "copilot-spaces/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-organization-copilot-spaces" }, "parameters": [ { @@ -120285,288 +120301,32 @@ "schema": { "type": "string" } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "title": "Copilot Organization Details", - "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.", - "type": "object", - "properties": { - "seat_breakdown": { - "title": "Copilot Seat Breakdown", - "description": "The breakdown of Copilot Business seats for the organization.", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "The total number of seats being billed for the organization as of the current billing cycle." - }, - "added_this_cycle": { - "type": "integer", - "description": "Seats added during the current billing cycle." - }, - "pending_cancellation": { - "type": "integer", - "description": "The number of seats that are pending cancellation at the end of the current billing cycle." - }, - "pending_invitation": { - "type": "integer", - "description": "The number of users who have been invited to receive a Copilot seat through this organization." - }, - "active_this_cycle": { - "type": "integer", - "description": "The number of seats that have used Copilot during the current billing cycle." - }, - "inactive_this_cycle": { - "type": "integer", - "description": "The number of seats that have not used Copilot during the current billing cycle." - } - } - }, - "public_code_suggestions": { - "type": "string", - "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).", - "enum": [ - "allow", - "block", - "unconfigured" - ] - }, - "ide_chat": { - "type": "string", - "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] - }, - "platform_chat": { - "type": "string", - "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] - }, - "cli": { - "type": "string", - "description": "The organization policy for allowing or disallowing Copilot CLI.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] - }, - "seat_management_setting": { - "type": "string", - "description": "The mode of assigning new seats.", - "enum": [ - "assign_all", - "assign_selected", - "disabled", - "unconfigured" - ] - }, - "plan_type": { - "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", - "enum": [ - "business", - "enterprise" - ] - } - }, - "required": [ - "seat_breakdown", - "public_code_suggestions", - "seat_management_setting" - ], - "additionalProperties": true - }, - "examples": { - "default": { - "value": { - "seat_breakdown": { - "total": 12, - "added_this_cycle": 9, - "pending_invitation": 0, - "pending_cancellation": 0, - "active_this_cycle": 12, - "inactive_this_cycle": 11 - }, - "seat_management_setting": "assign_selected", - "ide_chat": "enabled", - "platform_chat": "enabled", - "cli": "enabled", - "public_code_suggestions": "block", - "plan_type": "business" - } - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "There is a problem with your account's associated payment method." - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" - } - } - }, - "/orgs/{org}/copilot/billing/seats": { - "get": { - "summary": "List all Copilot seat assignments for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/list-copilot-seats", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" - }, - "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 } }, { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", "in": "query", "schema": { - "type": "integer", - "default": 1 + "type": "string" } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", "in": "query", "schema": { - "type": "integer", - "default": 50 + "type": "string" } } ], @@ -120577,23 +120337,76 @@ "application/json": { "schema": { "type": "object", + "required": [ + "spaces" + ], "properties": { - "total_seats": { - "type": "integer", - "description": "Total number of Copilot seats for the organization currently being billed." - }, - "seats": { + "spaces": { "type": "array", + "description": "The list of Copilot Spaces on this page of results.", "items": { - "title": "Copilot Business Seat Detail", - "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", "type": "object", "properties": { - "assignee": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { "anyOf": [ - { - "type": "null" - }, { "title": "Simple User", "description": "A GitHub user.", @@ -120761,13 +120574,6 @@ "type", "url" ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" }, { "title": "Organization Simple", @@ -120868,412 +120674,312 @@ "description" ] } - ] + ], + "description": "The user or organization that owns this space." }, - "assigning_team": { - "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", - "oneOf": [ - { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - { - "title": "Enterprise Team", - "description": "Group of enterprise owners and/or members", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "sync_to_organizations": { - "type": "string", - "description": "Retired: this field will not be returned with GHEC enterprise teams.", - "examples": [ - "disabled | all" - ] - }, - "organization_selection_type": { - "type": "string", - "examples": [ - "disabled | selected | all" - ] - }, - "group_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "62ab9291-fae2-468e-974b-7e45096d5021" - ] - }, - "group_name": { - "type": [ - "string", - "null" - ], - "description": "Retired: this field will not be returned with GHEC enterprise teams.", - "examples": [ - "Justice League" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/dc/teams/justice-league" - ] - }, - "members_url": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "url", - "members_url", - "name", - "html_url", - "slug", - "created_at", - "updated_at", - "group_id" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } - ], - "type": [ - "null", - "object" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "pending_cancellation_date": { - "type": [ - "string", - "null" - ], - "format": "date", - "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." - }, - "last_activity_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." - }, - "last_activity_editor": { - "type": [ - "string", - "null" - ], - "description": "Last editor that was used by the user for a GitHub Copilot completion." - }, - "last_authenticated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format." - }, "created_at": { "type": "string", "format": "date-time", - "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] }, "updated_at": { "type": "string", "format": "date-time", - "deprecated": true, - "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] }, - "plan_type": { + "html_url": { "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", - "enum": [ - "business", - "enterprise", - "unknown" + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } } }, "required": [ - "created_at" + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" ], "additionalProperties": false } @@ -121282,21 +120988,98 @@ }, "examples": { "default": { + "summary": "Example response for listing organization copilot spaces", "value": { - "total_seats": 2, - "seats": [ + "spaces": [ { - "created_at": "2021-08-03T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": null, - "last_activity_at": "2021-10-14T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "last_authenticated_at": "2021-10-14T00:53:32-06:00", - "plan_type": "business", - "assignee": { - "login": "octocat", + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "owner": { + "login": "octo-org", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3" + }, + { + "id": 85, + "number": 4, + "name": "Development Resources", + "description": "Shared development documentation and resources", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", @@ -121313,49 +121096,10 @@ "type": "User", "site_admin": false }, - "assigning_team": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - }, - { - "created_at": "2021-09-23T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": "2021-11-01", - "last_activity_at": "2021-10-13T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "last_authenticated_at": "2021-10-14T00:53:32-06:00", - "assignee": { - "login": "octokitten", - "id": 1, - "node_id": "MDQ76VNlcjE=", - "avatar_url": "https://github.com/images/error/octokitten_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octokitten", - "html_url": "https://github.com/octokitten", - "followers_url": "https://api.github.com/users/octokitten/followers", - "following_url": "https://api.github.com/users/octokitten/following{/other_user}", - "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", - "organizations_url": "https://api.github.com/users/octokitten/orgs", - "repos_url": "https://api.github.com/users/octokitten/repos", - "events_url": "https://api.github.com/users/octokitten/events{/privacy}", - "received_events_url": "https://api.github.com/users/octokitten/received_events", - "type": "User", - "site_admin": false - } + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/4", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/4" } ] } @@ -121372,58 +121116,6 @@ } } }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "403": { "description": "Forbidden", "content": { @@ -121478,24 +121170,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } - } - }, - "/orgs/{org}/copilot/billing/selected_teams": { + }, "post": { - "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "summary": "Create an organization Copilot Space", + "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/add-copilot-seats-for-teams", + "operationId": "copilot-spaces/create-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-an-organization-copilot-space" }, "parameters": [ { @@ -121509,292 +121198,855 @@ } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "selected_teams": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "Team Planning Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Organization space for team planning and coordination" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help the team with planning and coordination tasks" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions for organization members.\n- `no_access`: No default access (default)\n- `reader`: Organization members can read the space\n- `writer`: Organization members can read and edit the space\n- `admin`: Organization members have full admin access to the space", + "default": "no_access" + }, + "resources_attributes": { "type": "array", - "description": "List of team names within the organization to which to grant access to GitHub Copilot.", + "description": "Resources to attach to the space.", "items": { - "type": "string" - }, - "minItems": 1 + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } } }, "required": [ - "selected_teams" + "name" ] }, "examples": { "default": { "value": { - "selected_teams": [ - "engteam1", - "engteam2", - "engteam3" + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/planning.md" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology and holds daily standups" + } + } ] } } } } - }, - "required": true + } }, "responses": { "201": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats created for members of the specified team(s).", - "properties": { - "seats_created": { - "type": "integer" - } - }, - "required": [ - "seats_created" - ] - }, - "examples": { - "default": { - "value": { - "seats_created": 5 - } - } - } - } - } - }, - "500": { - "description": "Internal Error", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] }, - "url": { - "type": "string" + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] }, - "documentation_url": { - "type": "string" + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] }, - "url": { - "type": "string" + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] }, - "documentation_url": { - "type": "string" + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." }, - "url": { - "type": "string" + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] }, - "documentation_url": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] }, - "url": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" - } - }, - "delete": { - "summary": "Remove teams from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/cancel-copilot-seat-assignment-for-teams", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_teams": { - "type": "array", - "description": "The names of teams from which to revoke access to GitHub Copilot.", - "items": { - "type": "string" + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] }, - "minItems": 1 - } - }, - "required": [ - "selected_teams" - ] - }, - "examples": { - "default": { - "value": { - "selected_teams": [ - "engteam1", - "engteam2", - "engteam3" - ] - } - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", - "properties": { - "seats_cancelled": { - "type": "integer" + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } } }, "required": [ - "seats_cancelled" - ] + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false }, "examples": { "default": { + "summary": "Example response for an organization copilot space", "value": { - "seats_cancelled": 5 - } - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] } } } } } }, - "401": { - "description": "Requires authentication", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -121819,8 +122071,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -121845,14 +122097,18 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -121860,40 +122116,81 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } } }, - "/orgs/{org}/copilot/billing/selected_users": { - "post": { - "summary": "Add users to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "/orgs/{org}/copilot-spaces/{space_number}": { + "get": { + "summary": "Get an organization Copilot Space", + "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/add-copilot-seats-for-users", + "operationId": "copilot-spaces/get-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-an-organization-copilot-space" }, "parameters": [ { @@ -121904,313 +122201,738 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_usernames": { - "type": "array", - "description": "The usernames of the organization members to be granted access to GitHub Copilot.", - "items": { - "type": "string" - }, - "minItems": 1 - } - }, - "required": [ - "selected_usernames" - ] - }, - "examples": { - "default": { - "value": { - "selected_usernames": [ - "cooluser1", - "hacker2", - "octocat" - ] - } - } - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats created for the specified user(s).", - "properties": { - "seats_created": { - "type": "integer" - } - }, - "required": [ - "seats_created" - ] - }, - "examples": { - "default": { - "value": { - "seats_created": 5 - } - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" - } - }, - "delete": { - "summary": "Remove users from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/cancel-copilot-seat-assignment-for-users", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization" - }, - "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_usernames": { - "type": "array", - "description": "The usernames of the organization members for which to revoke access to GitHub Copilot.", - "items": { - "type": "string" - }, - "minItems": 1 - } - }, - "required": [ - "selected_usernames" - ] - }, - "examples": { - "default": { - "value": { - "selected_usernames": [ - "cooluser1", - "hacker2", - "octocat" - ] - } - } - } - } - }, - "required": true - }, "responses": { "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats set to \"pending cancellation\" for the specified users.", - "properties": { - "seats_cancelled": { - "type": "integer" - } - }, - "required": [ - "seats_cancelled" - ] - }, - "examples": { - "default": { - "value": { - "seats_cancelled": 5 - } - } - } - } - } - }, - "500": { - "description": "Internal Error", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] }, - "documentation_url": { - "type": "string" + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] }, - "url": { - "type": "string" + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] }, - "documentation_url": { - "type": "string" + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] }, - "url": { - "type": "string" + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] }, - "status": { - "type": "string" + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + }, + "examples": { + "default": { + "summary": "Example response for an organization copilot space", + "value": { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] } } } @@ -122268,30 +122990,24 @@ } } } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team." } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } - } - }, - "/orgs/{org}/copilot/coding-agent/permissions": { - "get": { - "summary": "Get Copilot coding agent permissions for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about which repositories in an organization have been enabled\nor disabled for the Copilot coding agent.\n\nOrganization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + }, + "put": { + "summary": "Set an organization Copilot Space", + "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/get-copilot-coding-agent-permissions-organization", + "operationId": "copilot-spaces/update-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-an-organization-copilot-space" }, "parameters": [ { @@ -122302,86 +123018,868 @@ "schema": { "type": "string" } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "Updated Team Planning Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Updated organization space for team planning and coordination" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Updated instructions to help the team with planning and coordination tasks" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions for organization members. Changing this field requires admin permissions.\n- `no_access`: No default access (default)\n- `reader`: Organization members can read the space\n- `writer`: Organization members can read and edit the space\n- `admin`: Organization members have full admin access to the space" + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "Updated Team Planning Space", + "description": "Updated organization space for team planning and coordination", + "general_instructions": "Updated instructions to help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/updated-planning.md" + } + }, + { + "id": 789, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Team Guidelines", + "text": "Our updated team follows agile methodology and holds daily standups" + } + } + ] + } + } + } + } + } + }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", "type": "object", "properties": { - "enabled_repositories": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", "enum": [ - "all", - "selected", - "none" + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" ] }, - "selected_repositories_url": { + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { "type": "string", - "description": "The URL for the selected repositories endpoint. Only present when `enabled_repositories` is `selected`." + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } } }, "required": [ - "enabled_repositories" - ] + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false }, "examples": { - "all_enabled": { - "summary": "All repositories enabled", - "value": { - "enabled_repositories": "all" - } - }, - "selected_enabled": { - "summary": "Selected repositories enabled", - "value": { - "enabled_repositories": "selected", - "selected_repositories_url": "https://api.github.com/orgs/my-org/copilot/coding-agent/permissions/repositories" - } - }, - "none_enabled": { - "summary": "No repositories enabled", + "default": { + "summary": "Example response for an organization copilot space", "value": { - "enabled_repositories": "none" - } - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] } } } } } }, - "401": { - "description": "Requires authentication", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -122406,8 +123904,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -122432,14 +123930,18 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -122447,11 +123949,56 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -122460,22 +124007,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } }, - "put": { - "summary": "Set Copilot coding agent permissions for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets the policy for which repositories in an organization can use Copilot coding agent.\n\nOrganization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "delete": { + "summary": "Delete an organization Copilot Space", + "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/set-copilot-coding-agent-permissions-organization", + "operationId": "copilot-spaces/delete-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-an-organization-copilot-space" }, "parameters": [ { @@ -122486,120 +124032,20 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "enabled_repositories": { - "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", - "enum": [ - "all", - "selected", - "none" - ] - } - }, - "required": [ - "enabled_repositories" - ] - }, - "examples": { - "default": { - "value": { - "enabled_repositories": "selected" - } - } - } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } - }, + ], "responses": { "204": { - "description": "No Content" - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } + "description": "The Copilot Space has been successfully deleted." }, "404": { "description": "Resource not found", @@ -122704,24 +124150,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } } }, - "/orgs/{org}/copilot/coding-agent/permissions/repositories": { + "/orgs/{org}/copilot-spaces/{space_number}/collaborators": { "get": { - "summary": "List repositories enabled for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists the selected repositories that are enabled for Copilot coding agent in an organization.\n\nOrganization owners can use this endpoint when the coding agent repository policy\nis set to `selected` to see which repositories have been enabled.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "List collaborators for an organization Copilot Space", + "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/list-copilot-coding-agent-selected-repositories-for-organization", + "operationId": "copilot-spaces/list-collaborators-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-an-organization-copilot-space" }, "parameters": [ { @@ -122734,21 +124179,12 @@ } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], @@ -122759,1192 +124195,375 @@ "application/json": { "schema": { "type": "object", + "required": [ + "collaborators" + ], "properties": { - "total_count": { - "type": "integer" - }, - "repositories": { + "collaborators": { "type": "array", + "description": "The list of collaborators for this Copilot Space.", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." }, - "login": { + "role": { "type": "string", - "examples": [ - "octocat" - ] + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" }, "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "type": "integer" }, "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "type": "string" }, - "avatar_url": { + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "enum": [ + "Team" ] }, - "gravatar_id": { + "description": { "type": [ "string", "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" ] }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "privacy": { + "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "notification_setting": { + "type": "string" }, - "repos_url": { + "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "format": "uri" }, - "events_url": { + "html_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri" }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "members_url": { + "type": "string" }, - "type": { + "repositories_url": { "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" + "format": "uri" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "organization_id": { + "type": "integer" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" + "parent": { + "type": [ + "null" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", + "actor_type", + "role", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "name", + "slug", + "type" ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_bypass": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - }, - "mode": { - "type": "string", - "description": "The bypass mode for the reviewer", - "enum": [ - "ALWAYS", - "EXEMPT" - ], - "default": "ALWAYS" - } - } - } - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" ] } } - }, - "required": [ - "total_count", - "repositories" - ] + } }, "examples": { "default": { "value": { - "total_count": 1, - "repositories": [ + "collaborators": [ { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "octo-org", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "organization": null, - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "template_repository": null, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "delete_branch_on_merge": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "description": "A great organization" + } } ] } @@ -123953,58 +124572,6 @@ } } }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "403": { "description": "Forbidden", "content": { @@ -124056,51 +124623,24 @@ } } } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "collaborators" } }, - "put": { - "summary": "Set selected repositories for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReplaces the list of selected repositories that are enabled for Copilot coding\nagent in an organization. This method can only be called when the coding agent\nrepository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "post": { + "summary": "Add a collaborator to an organization Copilot Space", + "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/set-copilot-coding-agent-selected-repositories-for-organization", + "operationId": "copilot-spaces/add-collaborator-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-an-organization-copilot-space" }, "parameters": [ { @@ -124111,6 +124651,15 @@ "schema": { "type": "string" } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -124119,27 +124668,48 @@ "application/json": { "schema": { "type": "object", + "required": [ + "actor_type", + "actor_identifier", + "role" + ], "properties": { - "selected_repository_ids": { - "description": "List of repository IDs to enable for Copilot coding agent.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - } + "actor_type": { + "type": "string", + "enum": [ + "User", + "Team" + ], + "description": "The type of actor (user or team)." + }, + "actor_identifier": { + "type": "string", + "description": "The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role to grant to the collaborator." } - }, - "required": [ - "selected_repository_ids" - ] + } }, "examples": { - "default": { + "user": { "value": { - "selected_repository_ids": [ - 32, - 42 - ] + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" + } + }, + "team": { + "value": { + "actor_type": "Team", + "actor_identifier": "developers", + "role": "reader" } } } @@ -124147,55 +124717,355 @@ } }, "responses": { - "204": { - "description": "No Content" - }, - "500": { - "description": "Internal Error", + "201": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] }, - "status": { - "type": "string" + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + ] + }, + "examples": { + "user": { + "value": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "team": { + "value": { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 } } } @@ -124254,32 +125124,6 @@ } } }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { @@ -124357,24 +125201,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "collaborators" } } }, - "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}": { + "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { "put": { - "summary": "Enable a repository for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nAdds a repository to the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Set a collaborator role for an organization Copilot Space", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/enable-copilot-coding-agent-for-repository-in-organization", + "operationId": "copilot-spaces/update-collaborator-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-an-organization-copilot-space" }, "parameters": [ { @@ -124387,71 +125230,428 @@ } }, { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { "type": "integer" } + }, + { + "name": "actor_type", + "description": "The type of actor (user or team).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], - "responses": { - "204": { - "description": "No Content" - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "role" + ], + "properties": { + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The new role to grant to the collaborator. Use `no_access` to remove the collaborator." + } + } + }, + "examples": { + "default": { + "value": { + "role": "admin" } } } } - }, - "401": { - "description": "Requires authentication", + } + }, + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] }, - "status": { - "type": "string" + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + }, + "examples": { + "user": { + "value": { + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "team": { + "value": { + "actor_type": "Team", + "role": "admin", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 } } } } } }, + "204": { + "description": "Response when `role` is `no_access` and the collaborator was removed." + }, "403": { "description": "Forbidden", "content": { @@ -124504,32 +125704,6 @@ } } }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { @@ -124607,22 +125781,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "collaborators" } }, "delete": { - "summary": "Disable a repository for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemoves a repository from the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint.", + "summary": "Remove a collaborator from an organization Copilot Space", + "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/disable-copilot-coding-agent-for-repository-in-organization", + "operationId": "copilot-spaces/remove-collaborator-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-an-organization-copilot-space" }, "parameters": [ { @@ -124635,70 +125808,40 @@ } }, { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { "type": "integer" } - } - ], - "responses": { - "204": { - "description": "No Content" }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } + { + "name": "actor_type", + "description": "The type of actor (user or team).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] } }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } + { + "name": "actor_identifier", + "description": "The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" } + } + ], + "responses": { + "204": { + "description": "Response" }, "403": { "description": "Forbidden", @@ -124751,53 +125894,26 @@ } } } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "collaborators" } } }, - "/orgs/{org}/copilot/content_exclusion": { + "/orgs/{org}/copilot-spaces/{space_number}/resources": { "get": { - "summary": "Get Copilot content exclusion rules for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot content exclusion path rules.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can view details about Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `copilot` or `read:org` scopes to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.\n> * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.", + "summary": "List resources for an organization Copilot Space", + "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/copilot-content-exclusion-for-organization", + "operationId": "copilot-spaces/list-resources-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-an-organization-copilot-space" }, "parameters": [ { @@ -124808,30 +125924,112 @@ "schema": { "type": "string" } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { "200": { - "description": "OK", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Copilot Organization Content Exclusion Details", - "description": "List all Copilot Content Exclusion rules for an organization.", "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string", - "description": "The path to the file that will be excluded." + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } } } }, "examples": { "default": { "value": { - "octo-repo": [ - "/src/some-dir/kernel.rs" + "resources": [ + { + "id": 1, + "resource_type": "repository", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42 + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + { + "id": 2, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } ] } } @@ -124839,8 +126037,8 @@ } } }, - "500": { - "description": "Internal Error", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -124865,60 +126063,8 @@ } } }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -124945,22 +126091,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-content-exclusion-management" + "category": "copilot-spaces", + "subcategory": "resources" } }, - "put": { - "summary": "Set Copilot content exclusion rules for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets Copilot content exclusion path rules for an organization.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can set Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.\n> * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.", + "post": { + "summary": "Create a resource for an organization Copilot Space", + "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/set-copilot-content-exclusion-for-organization", + "operationId": "copilot-spaces/create-resource-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-an-organization-copilot-space" }, "parameters": [ { @@ -124971,64 +126116,72 @@ "schema": { "type": "string" } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { - "description": "The content exclusion rules to set", "required": true, "content": { "application/json": { "schema": { "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string", - "description": "The path to the file that will be excluded." - }, - { - "type": "object", - "properties": { - "ifAnyMatch": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "ifAnyMatch" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ifNoneMatch": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "ifNoneMatch" - ], - "additionalProperties": false - } - ] + "required": [ + "resource_type", + "metadata" + ], + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ], + "description": "The type of resource to create." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata.", + "additionalProperties": true } } }, "examples": { - "default": { - "summary": "Example of content exclusion paths", + "free_text": { "value": { - "octo-repo": [ - "/src/some-dir/kernel.rs" - ] + "resource_type": "free_text", + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + } + } + }, + "repository": { + "value": { + "resource_type": "repository", + "metadata": { + "repository_id": 42 + } + } + }, + "github_file": { + "value": { + "resource_type": "github_file", + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + } } } } @@ -125036,74 +126189,151 @@ } }, "responses": { - "200": { - "description": "Success", + "201": { + "description": "Resource created", "content": { "application/json": { "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." } - } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] }, "examples": { "default": { "value": { - "message": "Content exclusion rules updated successfully." + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" } } } } } }, - "500": { - "description": "Internal Error", + "200": { + "description": "Duplicate github_file resource already exists", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "id": { + "type": "integer", + "description": "The unique identifier of the resource." }, - "url": { - "type": "string" + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." }, - "documentation_url": { - "type": "string" + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true }, - "url": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." }, - "status": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "github_file", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" } } } @@ -125162,39 +126392,13 @@ } } }, - "413": { - "description": "Payload Too Large", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Validation Error", + "description": "Validation Error", "type": "object", "required": [ "message", @@ -125210,7 +126414,52 @@ "errors": { "type": "array", "items": { - "type": "string" + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } } } } @@ -125220,24 +126469,23 @@ } }, "x-github": { - "githubCloudOnly": null, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-content-exclusion-management" + "category": "copilot-spaces", + "subcategory": "resources" } } }, - "/orgs/{org}/copilot/metrics": { + "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": { "get": { - "summary": "Get Copilot metrics for an organization", - "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "summary": "Get a resource for an organization Copilot Space", + "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/copilot-metrics-for-organization", + "operationId": "copilot-spaces/get-resource-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-an-organization-copilot-space" }, "parameters": [ { @@ -125250,39 +126498,21 @@ } }, { - "name": "since", - "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "until", - "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } }, { - "name": "per_page", - "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 100 + "type": "integer" } } ], @@ -125292,504 +126522,70 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Copilot Usage Metrics", - "description": "Copilot usage metrics for a given day.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "total_engaged_users": { - "type": "integer", - "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "copilot_ide_code_completions": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." - } - } - } - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot code completion metrics for active editors.", - "additionalProperties": true, - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages, for the given editor.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions, for the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_suggestions": { - "type": "integer", - "description": "The number of Copilot code suggestions generated for the given editor, for the given language." - }, - "total_code_acceptances": { - "type": "integer", - "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." - }, - "total_code_lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." - } - } - } - } - } - } - } - } - } - } - } - }, - "copilot_ide_chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in the IDE.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat in the IDE." - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot Chat metrics, for active editors.", - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the specified editor." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the given editor and model." - }, - "total_chats": { - "type": "integer", - "description": "The total number of chats initiated by users in the given editor and model." - }, - "total_chat_insertion_events": { - "type": "integer", - "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." - }, - "total_chat_copy_events": { - "type": "integer", - "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." - } - } - } - } - } - } - } - } - }, - "copilot_dotcom_chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in GitHub.com", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once." - }, - "models": { - "type": "array", - "description": "List of model metrics for a custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model (if applicable)." - }, - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." - }, - "total_chats": { - "type": "integer", - "description": "Total number of chats initiated by users on github.com." - } - } - } - } - } - }, - "copilot_dotcom_pull_requests": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot for pull requests.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." - }, - "repositories": { - "type": "array", - "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Repository name" - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_pr_summaries_created": { - "type": "integer", - "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." - } - } - } - } - } - } - } - } - } - }, - "required": [ - "date" - ], - "additionalProperties": true - } - }, - "examples": { - "default": { - "value": [ - { - "date": "2024-06-24", - "total_active_users": 24, - "total_engaged_users": 20, - "copilot_ide_code_completions": { - "total_engaged_users": 20, - "languages": [ - { - "name": "python", - "total_engaged_users": 10 - }, - { - "name": "ruby", - "total_engaged_users": 10 - } - ], - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 13, - "languages": [ - { - "name": "python", - "total_engaged_users": 6, - "total_code_suggestions": 249, - "total_code_acceptances": 123, - "total_code_lines_suggested": 225, - "total_code_lines_accepted": 135 - }, - { - "name": "ruby", - "total_engaged_users": 7, - "total_code_suggestions": 496, - "total_code_acceptances": 253, - "total_code_lines_suggested": 520, - "total_code_lines_accepted": 270 - } - ] - } - ] - }, - { - "name": "neovim", - "total_engaged_users": 7, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "languages": [ - { - "name": "typescript", - "total_engaged_users": 3, - "total_code_suggestions": 112, - "total_code_acceptances": 56, - "total_code_lines_suggested": 143, - "total_code_lines_accepted": 61 - }, - { - "name": "go", - "total_engaged_users": 4, - "total_code_suggestions": 132, - "total_code_acceptances": 67, - "total_code_lines_suggested": 154, - "total_code_lines_accepted": 72 - } - ] - } - ] - } - ] - }, - "copilot_ide_chat": { - "total_engaged_users": 13, - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 12, - "total_chats": 45, - "total_chat_insertion_events": 12, - "total_chat_copy_events": 16 - }, - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_engaged_users": 1, - "total_chats": 10, - "total_chat_insertion_events": 11, - "total_chat_copy_events": 3 - } - ] - } - ] - }, - "copilot_dotcom_chat": { - "total_engaged_users": 14, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 14, - "total_chats": 38 - } - ] - }, - "copilot_dotcom_pull_requests": { - "total_engaged_users": 12, - "repositories": [ - { - "name": "demo/repo1", - "total_engaged_users": 8, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_pr_summaries_created": 6, - "total_engaged_users": 8 - } - ] - }, - { - "name": "demo/repo2", - "total_engaged_users": 4, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_pr_summaries_created": 10, - "total_engaged_users": 4 - } - ] - } - ] - } - } - ] - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "type": "integer", + "description": "The unique identifier of the resource." }, - "documentation_url": { - "type": "string" + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] }, - "url": { - "type": "string" + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." }, - "status": { - "type": "string" + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" } } } @@ -125847,53 +126643,24 @@ } } } - }, - "422": { - "description": "Copilot Usage Metrics API setting is disabled at the organization or enterprise level.", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-metrics" + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/orgs/{org}/copilot/metrics/reports/organization-1-day": { - "get": { - "summary": "Get Copilot organization usage metrics for a specific day", - "description": "Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + }, + "put": { + "summary": "Set a resource for an organization Copilot Space", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/copilot-organization-one-day-usage-metrics", + "operationId": "copilot-spaces/update-resource-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day" + "url": "https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-an-organization-copilot-space" }, "parameters": [ { @@ -125906,67 +126673,129 @@ } }, { - "name": "day", - "description": "The day to request data for, in `YYYY-MM-DD` format.", - "in": "query", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", "required": true, "schema": { - "type": "string", - "format": "date", - "examples": [ - "2025-10-13" - ] + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "Updated resource-specific metadata.", + "additionalProperties": true + } + } + }, + "examples": { + "default": { + "value": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + } + } + } + } + } + }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", "type": "object", - "title": "Copilot Metrics 1 Day Report", - "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", "properties": { - "download_links": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + "id": { + "type": "integer", + "description": "The unique identifier of the resource." }, - "report_day": { + "resource_type": { "type": "string", - "format": "date", - "description": "The day of the report in `YYYY-MM-DD` format." + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." } }, "required": [ - "download_links", - "report_day" + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" ] }, "examples": { "default": { "value": { - "download_links": [ - "https://example.com/copilot-usage-report-1.json", - "https://example.com/copilot-usage-report-2.json" - ], - "report_day": "2025-07-01" + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" } } } } } }, - "204": { - "description": "A header with no content is returned." - }, - "500": { - "description": "Internal Error", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -125991,8 +126820,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -126017,14 +126846,18 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -126032,11 +126865,56 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -126045,24 +126923,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage-metrics" + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest": { - "get": { - "summary": "Get Copilot organization usage metrics", - "description": "Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + }, + "delete": { + "summary": "Delete a resource from an organization Copilot Space", + "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/copilot-organization-usage-metrics", + "operationId": "copilot-spaces/delete-resource-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics" + "url": "https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-an-organization-copilot-space" }, "parameters": [ { @@ -126073,83 +126948,29 @@ "schema": { "type": "string" } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Copilot Metrics 28 Day Report", - "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", - "properties": { - "download_links": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." - }, - "report_start_day": { - "type": "string", - "format": "date", - "description": "The start date of the report period in `YYYY-MM-DD` format." - }, - "report_end_day": { - "type": "string", - "format": "date", - "description": "The end date of the report period in `YYYY-MM-DD` format." - } - }, - "required": [ - "download_links", - "report_start_day", - "report_end_day" - ] - }, - "examples": { - "default": { - "value": { - "download_links": [ - "https://example.com/copilot-usage-report-1.json", - "https://example.com/copilot-usage-report-2.json" - ], - "report_start_day": "2025-07-01", - "report_end_day": "2025-07-28" - } - } - } - } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } + } + ], + "responses": { + "204": { + "description": "Response" }, "403": { "description": "Forbidden", @@ -126205,24 +127026,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage-metrics" + "category": "copilot-spaces", + "subcategory": "resources" } } }, - "/orgs/{org}/copilot/metrics/reports/users-1-day": { + "/orgs/{org}/copilot/billing": { "get": { - "summary": "Get Copilot organization users usage metrics for a specific day", - "description": "Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "summary": "Get Copilot seat information and settings for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], - "operationId": "copilot/copilot-organization-users-one-day-usage-metrics", + "operationId": "copilot/get-copilot-organization-details", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization" }, "parameters": [ { @@ -126233,67 +127053,134 @@ "schema": { "type": "string" } - }, - { - "name": "day", - "description": "The day to request data for, in `YYYY-MM-DD` format.", - "in": "query", - "required": true, - "schema": { - "type": "string", - "format": "date", - "examples": [ - "2025-10-13" - ] - } } ], "responses": { "200": { - "description": "Response", + "description": "OK", "content": { "application/json": { "schema": { + "title": "Copilot Organization Details", + "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.", "type": "object", - "title": "Copilot Metrics 1 Day Report", - "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", "properties": { - "download_links": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + "seat_breakdown": { + "title": "Copilot Seat Breakdown", + "description": "The breakdown of Copilot Business seats for the organization.", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "The total number of seats being billed for the organization as of the current billing cycle." + }, + "added_this_cycle": { + "type": "integer", + "description": "Seats added during the current billing cycle." + }, + "pending_cancellation": { + "type": "integer", + "description": "The number of seats that are pending cancellation at the end of the current billing cycle." + }, + "pending_invitation": { + "type": "integer", + "description": "The number of users who have been invited to receive a Copilot seat through this organization." + }, + "active_this_cycle": { + "type": "integer", + "description": "The number of seats that have used Copilot during the current billing cycle." + }, + "inactive_this_cycle": { + "type": "integer", + "description": "The number of seats that have not used Copilot during the current billing cycle." + } + } }, - "report_day": { + "public_code_suggestions": { "type": "string", - "format": "date", - "description": "The day of the report in `YYYY-MM-DD` format." + "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).", + "enum": [ + "allow", + "block", + "unconfigured" + ] + }, + "ide_chat": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "platform_chat": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "cli": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot CLI.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "seat_management_setting": { + "type": "string", + "description": "The mode of assigning new seats.", + "enum": [ + "assign_all", + "assign_selected", + "disabled", + "unconfigured" + ] + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise" + ] } }, "required": [ - "download_links", - "report_day" - ] + "seat_breakdown", + "public_code_suggestions", + "seat_management_setting" + ], + "additionalProperties": true }, "examples": { "default": { "value": { - "download_links": [ - "https://example.com/copilot-usage-report-1.json", - "https://example.com/copilot-usage-report-2.json" - ], - "report_day": "2025-07-01" + "seat_breakdown": { + "total": 12, + "added_this_cycle": 9, + "pending_invitation": 0, + "pending_cancellation": 0, + "active_this_cycle": 12, + "inactive_this_cycle": 11 + }, + "seat_management_setting": "assign_selected", + "ide_chat": "enabled", + "platform_chat": "enabled", + "cli": "enabled", + "public_code_suggestions": "block", + "plan_type": "business" } } } } } }, - "204": { - "description": "A header with no content is returned." - }, "500": { "description": "Internal Error", "content": { @@ -126320,142 +127207,8 @@ } } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage-metrics" - } - } - }, - "/orgs/{org}/copilot/metrics/reports/users-28-day/latest": { - "get": { - "summary": "Get Copilot organization users usage metrics", - "description": "Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", - "tags": [ - "copilot" - ], - "operationId": "copilot/copilot-organization-users-usage-metrics", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Copilot Metrics 28 Day Report", - "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", - "properties": { - "download_links": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." - }, - "report_start_day": { - "type": "string", - "format": "date", - "description": "The start date of the report period in `YYYY-MM-DD` format." - }, - "report_end_day": { - "type": "string", - "format": "date", - "description": "The end date of the report period in `YYYY-MM-DD` format." - } - }, - "required": [ - "download_links", - "report_start_day", - "report_end_day" - ] - }, - "examples": { - "default": { - "value": { - "download_links": [ - "https://example.com/copilot-usage-report-1.json", - "https://example.com/copilot-usage-report-2.json" - ], - "report_start_day": "2025-07-01", - "report_end_day": "2025-07-28" - } - } - } - } - } - }, - "500": { - "description": "Internal Error", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -126531,27 +127284,30 @@ } } } + }, + "422": { + "description": "There is a problem with your account's associated payment method." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "copilot", - "subcategory": "copilot-usage-metrics" + "subcategory": "copilot-user-management" } } }, - "/orgs/{org}/dependabot/alerts": { + "/orgs/{org}/copilot/billing/seats": { "get": { - "summary": "List Dependabot alerts for an organization", - "description": "Lists Dependabot alerts for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "summary": "List all Copilot seat assignments for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/list-alerts-for-org", + "operationId": "copilot/list-copilot-seats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" }, "parameters": [ { @@ -126564,163 +127320,12 @@ } }, { - "name": "classification", - "in": "query", - "description": "A comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned.\n\nCan be: `malware`, `general`", - "schema": { - "type": "string" - } - }, - { - "name": "state", - "in": "query", - "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`", - "schema": { - "type": "string" - } - }, - { - "name": "severity", - "in": "query", - "description": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`", - "schema": { - "type": "string" - } - }, - { - "name": "ecosystem", - "in": "query", - "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`", - "schema": { - "type": "string" - } - }, - { - "name": "package", - "in": "query", - "description": "A comma-separated list of package names. If specified, only alerts for these packages will be returned.", - "schema": { - "type": "string" - } - }, - { - "name": "epss_percentage", - "in": "query", - "description": "CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.", - "schema": { - "type": "string" - } - }, - { - "name": "artifact_registry_url", - "in": "query", - "description": "A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.", - "schema": { - "type": "string" - } - }, - { - "name": "artifact_registry", - "in": "query", - "description": "A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned.\n\nCan be: `jfrog-artifactory`", - "schema": { - "type": "string" - } - }, - { - "name": "has", - "in": "query", - "description": "Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple `has` filters can be passed to filter for alerts that have all of the values.", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "patch", - "deployment" - ] - } - } - ] - } - }, - { - "name": "assignee", - "in": "query", - "description": "Filter alerts by assignees.\nProvide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users.\nUse `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.", - "schema": { - "type": "string" - } - }, - { - "name": "runtime_risk", - "in": "query", - "description": "A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned.\n\nCan be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement`", - "schema": { - "type": "string" - } - }, - { - "name": "scope", - "in": "query", - "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.", - "schema": { - "type": "string", - "enum": [ - "development", - "runtime" - ] - } - }, - { - "name": "sort", - "in": "query", - "description": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.", - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "epss_percentage" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", - "required": false, "schema": { - "type": "string" + "type": "integer", + "default": 1 } }, { @@ -126729,7 +127334,7 @@ "in": "query", "schema": { "type": "integer", - "default": 30 + "default": 50 } } ], @@ -126739,2271 +127344,70 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "description": "A Dependabot alert.", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the Dependabot alert.", - "readOnly": true, - "enum": [ - "auto_dismissed", - "dismissed", - "fixed", - "open" - ] - }, - "dependency": { - "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "manifest_path": { - "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true - }, - "scope": { - "type": [ - "string", - "null" - ], - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "enum": [ - "development", - "runtime", - null - ] - }, - "relationship": { - "type": [ - "string", - "null" - ], - "description": "The vulnerable dependency's relationship to your project.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.\n", - "readOnly": true, - "enum": [ - "unknown", - "direct", - "transitive", - "inconclusive", - null - ] - } - } - }, - "security_advisory": { + "type": "object", + "properties": { + "total_seats": { + "type": "integer", + "description": "Total number of Copilot seats for the organization currently being billed." + }, + "seats": { + "type": "array", + "items": { + "title": "Copilot Business Seat Detail", + "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, "properties": { - "ghsa_id": { - "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true - }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true - }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } + "assignee": { + "anyOf": [ + { + "type": "null" }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - } - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "classification": { - "type": "string", - "description": "The classification of the advisory.", - "readOnly": true, - "enum": [ - "general", - "malware" - ] - }, - "cvss_severities": { - "type": [ - "object", - "null" - ], - "properties": { - "cvss_v3": { - "type": [ - "object", - "null" - ], + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "vector_string": { + "name": { "type": [ "string", "null" - ], - "description": "The CVSS 3 vector string." + ] }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { + "email": { "type": [ "string", "null" - ], - "description": "The CVSS 4 vector string." + ] }, - "score": { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "number", - "null" - ], - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - } - } - }, - "epss": { - "type": [ - "object", - "null" - ], - "readOnly": true, - "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", - "properties": { - "percentage": { - "type": "number", - "minimum": 0, - "maximum": 100 - }, - "percentile": { - "type": "number", - "minimum": 0, - "maximum": 100 - } - } - }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } - }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { - "type": "object", - "description": "An advisory identifier.", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true - } - }, - "required": [ - "value", - "type" - ], - "additionalProperties": false - } - }, - "references": { - "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, - "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } - }, - "required": [ - "url" - ], - "additionalProperties": false - } - }, - "published_at": { - "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - } - }, - "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", - "severity", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false - }, - "security_vulnerability": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "created_at": { - "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "The reason that the alert was dismissed.", - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment associated with the alert's dismissal.", - "maxLength": 280 - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "auto_dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissal_request": { - "title": "Dependabot alert dismissal request", - "description": "Information about an active dismissal request for this Dependabot alert.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the dismissal request." - }, - "status": { - "type": "string", - "description": "The current status of the dismissal request.", - "enum": [ - "pending", - "approved", - "rejected", - "cancelled" - ] - }, - "requester": { - "type": "object", - "description": "The user who requested the dismissal.", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the user." - }, - "login": { - "type": "string", - "description": "The login name of the user." - } - } - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time when the dismissal request was created." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The API URL to get more information about this dismissal request." - } - } - }, - "assignees": { - "type": "array", - "description": "The users assigned to this alert.", - "readOnly": true, - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" - ] - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - } - }, - "required": [ - "number", - "state", - "dependency", - "security_advisory", - "security_vulnerability", - "url", - "html_url", - "created_at", - "updated_at", - "dismissed_at", - "dismissed_by", - "dismissed_reason", - "dismissed_comment", - "fixed_at", - "repository" - ], - "additionalProperties": false - } - }, - "examples": { - "default": { - "value": [ - { - "number": 2, - "state": "dismissed", - "dependency": { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "manifest_path": "path/to/requirements.txt", - "scope": "runtime" - }, - "security_advisory": { - "ghsa_id": "GHSA-rf4j-j272-fj86", - "cve_id": "CVE-2018-6188", - "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", - "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 2.0.0, < 2.0.2", - "first_patched_version": { - "identifier": "2.0.2" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 1.11.8, < 1.11.10", - "first_patched_version": { - "identifier": "1.11.10" - } - } - ], - "severity": "high", - "cvss": { - "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", - "score": 7.5 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", - "score": 7.5 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", - "score": 8.7 - } - }, - "epss": { - "percentage": 0.00045, - "percentile": "0.16001e0" - }, - "cwes": [ - { - "cwe_id": "CWE-200", - "name": "Exposure of Sensitive Information to an Unauthorized Actor" - } - ], - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-rf4j-j272-fj86" - }, - { - "type": "CVE", - "value": "CVE-2018-6188" - } - ], - "references": [ - { - "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" - }, - { - "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" - }, - { - "url": "https://usn.ubuntu.com/3559-1/" - }, - { - "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" - }, - { - "url": "http://www.securitytracker.com/id/1040422" - } - ], - "published_at": "2018-10-03T21:13:54Z", - "updated_at": "2022-04-26T18:35:37Z", - "withdrawn_at": null - }, - "security_vulnerability": { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 2.0.0, < 2.0.2", - "first_patched_version": { - "identifier": "2.0.2" - } - }, - "url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2", - "html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2", - "created_at": "2022-06-15T07:43:03Z", - "updated_at": "2022-08-23T14:29:47Z", - "dismissed_at": "2022-08-23T14:29:47Z", - "dismissed_by": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "dismissed_reason": "tolerable_risk", - "dismissed_comment": "This alert is accurate but we use a sanitizer.", - "fixed_at": null, - "assignees": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ], - "repository": { - "id": 217723378, - "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", - "name": "octo-repo", - "full_name": "octo-org/octo-repo", - "owner": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "private": true, - "html_url": "https://github.com/octo-org/octo-repo", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octo-org/octo-repo", - "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", - "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", - "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", - "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", - "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", - "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", - "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}" - } - }, - { - "number": 1, - "state": "open", - "dependency": { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "manifest_path": "path/to/requirements.txt", - "scope": "runtime" - }, - "security_advisory": { - "ghsa_id": "GHSA-8f4m-hccc-8qph", - "cve_id": "CVE-2021-20191", - "summary": "Insertion of Sensitive Information into Log File in ansible", - "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": ">= 2.9.0, < 2.9.18", - "first_patched_version": { - "identifier": "2.9.18" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { - "identifier": "2.8.19" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": ">= 2.10.0, < 2.10.7", - "first_patched_version": { - "identifier": "2.10.7" - } - } - ], - "severity": "medium", - "cvss": { - "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", - "score": 5.5 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", - "score": 5.5 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", - "score": 8.5 - } - }, - "cwes": [ - { - "cwe_id": "CWE-532", - "name": "Insertion of Sensitive Information into Log File" - } - ], - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-8f4m-hccc-8qph" - }, - { - "type": "CVE", - "value": "CVE-2021-20191" - } - ], - "references": [ - { - "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" - }, - { - "url": "https://access.redhat.com/security/cve/cve-2021-20191" - }, - { - "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" - } - ], - "published_at": "2021-06-01T17:38:00Z", - "updated_at": "2021-08-12T23:06:00Z", - "withdrawn_at": null - }, - "security_vulnerability": { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { - "identifier": "2.8.19" - } - }, - "url": "https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1", - "html_url": "https://github.com/octo-org/hello-world/security/dependabot/1", - "created_at": "2022-06-14T15:21:52Z", - "updated_at": "2022-06-14T15:21:52Z", - "dismissed_at": null, - "dismissed_by": null, - "dismissed_reason": null, - "dismissed_comment": null, - "fixed_at": null, - "assignees": [], - "repository": { - "id": 664700648, - "node_id": "MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=", - "name": "hello-world", - "full_name": "octo-org/hello-world", - "owner": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "private": true, - "html_url": "https://github.com/octo-org/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octo-org/hello-world", - "archive_url": "https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octo-org/hello-world/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octo-org/hello-world/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octo-org/hello-world/comments{/number}", - "commits_url": "https://api.github.com/repos/octo-org/hello-world/commits{/sha}", - "compare_url": "https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octo-org/hello-world/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octo-org/hello-world/contributors", - "deployments_url": "https://api.github.com/repos/octo-org/hello-world/deployments", - "downloads_url": "https://api.github.com/repos/octo-org/hello-world/downloads", - "events_url": "https://api.github.com/repos/octo-org/hello-world/events", - "forks_url": "https://api.github.com/repos/octo-org/hello-world/forks", - "git_commits_url": "https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}", - "hooks_url": "https://api.github.com/repos/octo-org/hello-world/hooks", - "issue_comment_url": "https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octo-org/hello-world/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octo-org/hello-world/issues{/number}", - "keys_url": "https://api.github.com/repos/octo-org/hello-world/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octo-org/hello-world/labels{/name}", - "languages_url": "https://api.github.com/repos/octo-org/hello-world/languages", - "merges_url": "https://api.github.com/repos/octo-org/hello-world/merges", - "milestones_url": "https://api.github.com/repos/octo-org/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octo-org/hello-world/pulls{/number}", - "releases_url": "https://api.github.com/repos/octo-org/hello-world/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octo-org/hello-world/stargazers", - "statuses_url": "https://api.github.com/repos/octo-org/hello-world/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octo-org/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/hello-world/subscription", - "tags_url": "https://api.github.com/repos/octo-org/hello-world/tags", - "teams_url": "https://api.github.com/repos/octo-org/hello-world/teams", - "trees_url": "https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}" - } - } - ] - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "alerts" - } - } - }, - "/orgs/{org}/dependabot/repository-access": { - "get": { - "summary": "Lists the repositories Dependabot can access in an organization", - "description": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/repository-access-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "in": "query", - "description": "The page number of results to fetch.", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "default": 1 - } - }, - { - "name": "per_page", - "in": "query", - "description": "Number of results per page.", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Dependabot Repository Access Details", - "description": "Information about repositories that Dependabot is able to access in an organization", - "type": "object", - "properties": { - "default_level": { - "type": [ - "string", - "null" - ], - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal", - null - ], - "examples": [ - "internal" - ] - }, - "accessible_repositories": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", + "string", "null" ], "examples": [ @@ -129125,382 +127529,546 @@ "type", "url" ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + } + ] + }, + "assigning_team": { + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", + "oneOf": [ + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent", + "type" ] }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" + { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "description": "Retired: this field will not be returned with GHEC enterprise teams.", + "examples": [ + "disabled | all" + ] + }, + "organization_selection_type": { + "type": "string", + "examples": [ + "disabled | selected | all" + ] + }, + "group_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "62ab9291-fae2-468e-974b-7e45096d5021" + ] + }, + "group_name": { + "type": [ + "string", + "null" + ], + "description": "Retired: this field will not be returned with GHEC enterprise teams.", + "examples": [ + "Justice League" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/dc/teams/justice-league" + ] + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "name", + "html_url", + "slug", + "created_at", + "updated_at", + "group_id" ] } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" + ], + "type": [ + "null", + "object" + ] + }, + "pending_cancellation_date": { + "type": [ + "string", + "null" + ], + "format": "date", + "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." + }, + "last_activity_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + }, + "last_activity_editor": { + "type": [ + "string", + "null" + ], + "description": "Last editor that was used by the user for a GitHub Copilot completion." + }, + "last_authenticated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "deprecated": true, + "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise", + "unknown" ] } - ] + }, + "required": [ + "created_at" + ], + "additionalProperties": false } } - }, - "additionalProperties": false + } }, "examples": { "default": { "value": { - "default_level": "public", - "accessible_repositories": [ + "total_seats": 2, + "seats": [ { - "id": 123456, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", - "name": "example-repo", - "full_name": "octocat/example-repo", - "owner": { - "name": "octocat", - "email": "octo@github.com", + "created_at": "2021-08-03T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": null, + "last_activity_at": "2021-10-14T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "last_authenticated_at": "2021-10-14T00:53:32-06:00", + "plan_type": "business", + "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", - "gravatar_id": 1, + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat/example-repo", + "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", @@ -129511,57 +128079,117 @@ "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", - "site_admin": false, - "starred_at": "\"2020-07-09T00:17:55Z\"", - "user_view_type": "default" + "site_admin": false }, - "private": false, - "html_url": "https://github.com/octocat/example-repo", - "description": "This is an example repository.", - "fork": false, - "url": "https://api.github.com/repos/octocat/example-repo", - "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", - "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", - "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", - "events_url": "https://api.github.com/repos/octocat/example-repo/events", - "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", - "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", - "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", - "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", - "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", - "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", - "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", - "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", - "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + "assigning_team": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + }, + { + "created_at": "2021-09-23T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": "2021-11-01", + "last_activity_at": "2021-10-13T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "last_authenticated_at": "2021-10-14T00:53:32-06:00", + "assignee": { + "login": "octokitten", + "id": 1, + "node_id": "MDQ76VNlcjE=", + "avatar_url": "https://github.com/images/error/octokitten_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octokitten", + "html_url": "https://github.com/octokitten", + "followers_url": "https://api.github.com/users/octokitten/followers", + "following_url": "https://api.github.com/users/octokitten/following{/other_user}", + "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", + "organizations_url": "https://api.github.com/users/octokitten/orgs", + "repos_url": "https://api.github.com/users/octokitten/repos", + "events_url": "https://api.github.com/users/octokitten/events{/privacy}", + "received_events_url": "https://api.github.com/users/octokitten/received_events", + "type": "User", + "site_admin": false + } } ] } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } } }, "403": { @@ -129620,20 +128248,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "copilot", + "subcategory": "copilot-user-management" } - }, - "patch": { - "summary": "Updates Dependabot's repository access list for an organization", - "description": "Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.\n\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", + } + }, + "/orgs/{org}/copilot/billing/selected_teams": { + "post": { + "summary": "Add teams to the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/update-repository-access-for-org", + "operationId": "copilot/add-copilot-seats-for-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization" }, "parameters": [ { @@ -129647,65 +128277,117 @@ } ], "requestBody": { - "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "repository_ids_to_add": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "List of repository IDs to add." - }, - "repository_ids_to_remove": { + "selected_teams": { "type": "array", + "description": "List of team names within the organization to which to grant access to GitHub Copilot.", "items": { - "type": "integer" + "type": "string" }, - "description": "List of repository IDs to remove." + "minItems": 1 } }, - "example": { - "repository_ids_to_add": [ - 123, - 456 - ], - "repository_ids_to_remove": [ - 789 - ] - } + "required": [ + "selected_teams" + ] }, "examples": { - "204": { - "summary": "Example with a 'succeeded' status." - }, - "add-example": { - "summary": "Add repositories", - "value": { - "repository_ids_to_add": [ - 123, - 456 - ] - } - }, - "remove-example": { - "summary": "Remove repositories", + "default": { "value": { - "repository_ids_to_remove": [ - 789 + "selected_teams": [ + "engteam1", + "engteam2", + "engteam3" ] } } } } - } + }, + "required": true }, "responses": { - "204": { - "description": "Response" + "201": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The total number of seats created for members of the specified team(s).", + "properties": { + "seats_created": { + "type": "integer" + } + }, + "required": [ + "seats_created" + ] + }, + "examples": { + "default": { + "value": { + "seats_created": 5 + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } }, "403": { "description": "Forbidden", @@ -129758,27 +128440,28 @@ } } } + }, + "422": { + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "copilot", + "subcategory": "copilot-user-management" } - } - }, - "/orgs/{org}/dependabot/repository-access/default-level": { - "put": { - "summary": "Set the default repository access level for Dependabot", - "description": "Sets the default level of repository access Dependabot will have while performing an update. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.\n\nThis operation supports both server-to-server and user-to-server access.", + }, + "delete": { + "summary": "Remove teams from the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/set-repository-access-default-level", + "operationId": "copilot/cancel-copilot-seat-assignment-for-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization" }, "parameters": [ { @@ -129792,42 +128475,117 @@ } ], "requestBody": { - "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "default_level": { - "type": "string", - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal" - ], - "examples": [ - "internal" - ] + "selected_teams": { + "type": "array", + "description": "The names of teams from which to revoke access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 } }, "required": [ - "default_level" + "selected_teams" ] }, "examples": { - "204": { - "summary": "Example with a 'succeeded' status.", + "default": { "value": { - "default_level": "public" + "selected_teams": [ + "engteam1", + "engteam2", + "engteam3" + ] } } } } - } + }, + "required": true }, "responses": { - "204": { - "description": "Response" + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", + "properties": { + "seats_cancelled": { + "type": "integer" + } + }, + "required": [ + "seats_cancelled" + ] + }, + "examples": { + "default": { + "value": { + "seats_cancelled": 5 + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } }, "403": { "description": "Forbidden", @@ -129880,27 +128638,30 @@ } } } + }, + "422": { + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "copilot", + "subcategory": "copilot-user-management" } } }, - "/orgs/{org}/dependabot/secrets": { - "get": { - "summary": "List organization secrets", - "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "/orgs/{org}/copilot/billing/selected_users": { + "post": { + "summary": "Add users to the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/list-org-secrets", + "operationId": "copilot/add-copilot-seats-for-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#list-organization-secrets" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization" }, "parameters": [ { @@ -129911,149 +128672,194 @@ "schema": { "type": "string" } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members to be granted access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "selected_usernames" + ] + }, + "examples": { + "default": { + "value": { + "selected_usernames": [ + "cooluser1", + "hacker2", + "octocat" + ] + } + } + } + } + }, + "required": true + }, "responses": { - "200": { - "description": "Response", + "201": { + "description": "OK", "content": { "application/json": { "schema": { "type": "object", - "required": [ - "total_count", - "secrets" - ], + "description": "The total number of seats created for the specified user(s).", "properties": { - "total_count": { + "seats_created": { "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "title": "Dependabot Secret for an Organization", - "description": "Secrets for GitHub Dependabot for an organization.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" - ] - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - } } - } + }, + "required": [ + "seats_created" + ] }, "examples": { "default": { "value": { - "total_count": 3, - "secrets": [ - { - "name": "MY_ARTIFACTORY_PASSWORD", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2021-12-10T14:59:22Z", - "visibility": "private" - }, - { - "name": "NPM_TOKEN", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2021-12-10T14:59:22Z", - "visibility": "all" - }, - { - "name": "GH_TOKEN", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2021-12-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories" - } - ] + "seats_created": 5 } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } } } } + }, + "422": { + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-user-management" } - } - }, - "/orgs/{org}/dependabot/secrets/public-key": { - "get": { - "summary": "Get an organization public key", - "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + }, + "delete": { + "summary": "Remove users from the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/get-org-public-key", + "operationId": "copilot/cancel-copilot-seat-assignment-for-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization" }, "parameters": [ { @@ -130066,67 +128872,194 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members for which to revoke access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "selected_usernames" + ] + }, + "examples": { + "default": { + "value": { + "selected_usernames": [ + "cooluser1", + "hacker2", + "octocat" + ] + } + } + } + } + }, + "required": true + }, "responses": { "200": { - "description": "Response", + "description": "OK", "content": { "application/json": { "schema": { - "title": "DependabotPublicKey", - "description": "The public key used for setting Dependabot Secrets.", "type": "object", + "description": "The total number of seats set to \"pending cancellation\" for the specified users.", "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string", - "examples": [ - "1234567" - ] - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "examples": [ - "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" - ] + "seats_cancelled": { + "type": "integer" } }, "required": [ - "key_id", - "key" + "seats_cancelled" ] }, "examples": { "default": { "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + "seats_cancelled": 5 + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } + }, + "422": { + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-user-management" } } }, - "/orgs/{org}/dependabot/secrets/{secret_name}": { + "/orgs/{org}/copilot/coding-agent/permissions": { "get": { - "summary": "Get an organization secret", - "description": "Gets a single organization secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Get Copilot cloud agent permissions for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about which repositories in an organization have been enabled\nor disabled for the Copilot cloud agent.\n\nOrganization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/get-org-secret", + "operationId": "copilot/get-copilot-coding-agent-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-cloud-agent-permissions-for-an-organization" }, "parameters": [ { @@ -130137,15 +129070,6 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "responses": { @@ -130154,57 +129078,148 @@ "content": { "application/json": { "schema": { - "title": "Dependabot Secret for an Organization", - "description": "Secrets for GitHub Dependabot for an organization.", "type": "object", "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { + "enabled_repositories": { "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a secret", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", - "private", - "selected" - ], - "type": "string" + "selected", + "none" + ] }, "selected_repositories_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" - ] + "description": "The URL for the selected repositories endpoint. Only present when `enabled_repositories` is `selected`." } }, "required": [ - "name", - "created_at", - "updated_at", - "visibility" + "enabled_repositories" ] }, "examples": { - "default": { + "all_enabled": { + "summary": "All repositories enabled", "value": { - "name": "NPM_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories" + "enabled_repositories": "all" + } + }, + "selected_enabled": { + "summary": "Selected repositories enabled", + "value": { + "enabled_repositories": "selected", + "selected_repositories_url": "https://api.github.com/orgs/my-org/copilot/coding-agent/permissions/repositories" + } + }, + "none_enabled": { + "summary": "No repositories enabled", + "value": { + "enabled_repositories": "none" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -130215,20 +129230,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-coding-agent-management" } }, "put": { - "summary": "Create or update an organization secret", - "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Set Copilot cloud agent permissions for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets the policy for which repositories in an organization can use Copilot cloud agent.\n\nOrganization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/create-or-update-org-secret", + "operationId": "copilot/set-copilot-coding-agent-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-cloud-agent-permissions-for-an-organization" }, "parameters": [ { @@ -130239,15 +129254,6 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { @@ -130257,46 +129263,24 @@ "schema": { "type": "object", "properties": { - "encrypted_value": { - "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint.", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "type": "string", - "description": "ID of the key you used to encrypt the secret." - }, - "visibility": { + "enabled_repositories": { "type": "string", - "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", - "private", - "selected" + "selected", + "none" ] - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", - "items": { - "type": "integer" - } } }, "required": [ - "visibility" + "enabled_repositories" ] }, "examples": { "default": { "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] + "enabled_repositories": "selected" } } } @@ -130304,162 +129288,266 @@ } }, "responses": { - "201": { - "description": "Response when creating a secret", + "204": { + "description": "No Content" + }, + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } } } } }, - "204": { - "description": "Response when updating a secret" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - }, - "delete": { - "summary": "Delete an organization secret", - "description": "Deletes a secret in an organization using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/delete-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { - "get": { - "summary": "List selected repositories for an organization secret", - "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/list-selected-repos-for-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - } - ], - "responses": { - "200": { - "description": "Response", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "repositories": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-coding-agent-management" + } + } + }, + "/orgs/{org}/copilot/coding-agent/permissions/repositories": { + "get": { + "summary": "List repositories enabled for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists the selected repositories that are enabled for Copilot cloud agent in an organization.\n\nOrganization owners can use this endpoint when the coding agent repository policy\nis set to `selected` to see which repositories have been enabled.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/list-copilot-coding-agent-selected-repositories-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-cloud-agent-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, @@ -131374,7 +130462,11 @@ ] } } - } + }, + "required": [ + "total_count", + "repositories" + ] }, "examples": { "default": { @@ -131448,7 +130540,179 @@ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "organization": null, + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 } ] } @@ -131456,25 +130720,155 @@ } } } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-coding-agent-management" } }, "put": { - "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Set selected repositories for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReplaces the list of selected repositories that are enabled for Copilot cloud\nagent in an organization. This method can only be called when the cloud agent\nrepository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/set-selected-repos-for-org-secret", + "operationId": "copilot/set-copilot-coding-agent-selected-repositories-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -131485,15 +130879,6 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { @@ -131504,10 +130889,11 @@ "type": "object", "properties": { "selected_repository_ids": { + "description": "List of repository IDs to enable for Copilot cloud agent.", "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { - "type": "integer" + "type": "integer", + "description": "Unique identifier of the repository." } } }, @@ -131519,7 +130905,8 @@ "default": { "value": { "selected_repository_ids": [ - 64780797 + 32, + 42 ] } } @@ -131529,28 +130916,233 @@ }, "responses": { "204": { - "description": "Response" + "description": "No Content" + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-coding-agent-management" } } }, - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}": { "put": { - "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Enable a repository for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nAdds a repository to the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/add-selected-repo-to-org-secret", + "operationId": "copilot/enable-copilot-coding-agent-for-repository-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -131562,17 +131154,9 @@ "type": "string" } }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, { "name": "repository_id", + "description": "The unique identifier of the repository.", "in": "path", "required": true, "schema": { @@ -131582,29 +131166,231 @@ ], "responses": { "204": { - "description": "No Content when repository was added to the selected list" + "description": "No Content" + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } }, "409": { - "description": "Conflict when visibility type is not set to selected" + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-coding-agent-management" } }, "delete": { - "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Disable a repository for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemoves a repository from the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/remove-selected-repo-from-org-secret", + "operationId": "copilot/disable-copilot-coding-agent-for-repository-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -131617,50 +131403,609 @@ } }, { - "name": "secret_name", - "description": "The name of the secret.", + "name": "repository_id", + "description": "The unique identifier of the repository.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } } }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-coding-agent-management" + } + } + }, + "/orgs/{org}/copilot/content_exclusion": { + "get": { + "summary": "Get Copilot content exclusion rules for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot content exclusion path rules.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can view details about Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `copilot` or `read:org` scopes to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.\n> * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-content-exclusion-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization" + }, + "parameters": [ { - "name": "repository_id", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], "responses": { - "204": { - "description": "Response when repository was removed from the selected list" + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "title": "Copilot Organization Content Exclusion Details", + "description": "List all Copilot Content Exclusion rules for an organization.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string", + "description": "The path to the file that will be excluded." + } + } + }, + "examples": { + "default": { + "value": { + "octo-repo": [ + "/src/some-dir/kernel.rs" + ] + } + } + } + } + } }, - "409": { - "description": "Conflict when visibility type not set to selected" + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-content-exclusion-management" + } + }, + "put": { + "summary": "Set Copilot content exclusion rules for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets Copilot content exclusion path rules for an organization.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can set Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.\n> * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.", + "tags": [ + "copilot" + ], + "operationId": "copilot/set-copilot-content-exclusion-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The content exclusion rules to set", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string", + "description": "The path to the file that will be excluded." + }, + { + "type": "object", + "properties": { + "ifAnyMatch": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "ifAnyMatch" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ifNoneMatch": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "ifNoneMatch" + ], + "additionalProperties": false + } + ] + } + } + }, + "examples": { + "default": { + "summary": "Example of content exclusion paths", + "value": { + "octo-repo": [ + "/src/some-dir/kernel.rs" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Content exclusion rules updated successfully." + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "413": { + "description": "Payload Too Large", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": null, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-content-exclusion-management" } } }, - "/orgs/{org}/docker/conflicts": { + "/orgs/{org}/copilot/metrics": { "get": { - "summary": "Get list of conflicting packages during Docker migration for organization", - "description": "Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", + "summary": "Get Copilot metrics for an organization", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", "tags": [ - "packages" + "copilot" ], - "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", + "operationId": "copilot/copilot-metrics-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" }, "parameters": [ { @@ -131671,6 +132016,42 @@ "schema": { "type": "string" } + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 100 + } } ], "responses": { @@ -131681,1263 +132062,475 @@ "schema": { "type": "array", "items": { - "title": "Package", - "description": "A software package", + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the package.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the package.", - "type": "string", - "examples": [ - "super-linter" - ] - }, - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ], - "examples": [ - "docker" - ] - }, - "url": { + "date": { "type": "string", - "examples": [ - "https://api.github.com/orgs/github/packages/container/super-linter" - ] + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." }, - "html_url": { - "type": "string", - "examples": [ - "https://github.com/orgs/github/packages/container/package/super-linter" - ] + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." }, - "version_count": { - "description": "The number of versions of the package.", + "total_engaged_users": { "type": "integer", - "examples": [ - 1 - ] + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." }, - "visibility": { - "type": "string", - "enum": [ - "private", - "public" + "copilot_ide_code_completions": { + "type": [ + "object", + "null" ], - "examples": [ - "private" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } } - ] + } }, - "repository": { - "anyOf": [ - { - "type": "null" + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." }, - { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_alert_dismissal": { + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { "type": "object", "properties": { - "status": { + "name": { "type": "string", - "enum": [ - "enabled", - "disabled" - ] + "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." } } - }, - "secret_scanning_delegated_bypass": { + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in GitHub.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { "type": "object", "properties": { - "status": { + "name": { "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - }, - "mode": { - "type": "string", - "description": "The bypass mode for the reviewer", - "enum": [ - "ALWAYS", - "EXEMPT" - ], - "default": "ALWAYS" - } - } - } + "description": "Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." } } } } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] + } } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" + } } }, "required": [ - "id", - "name", - "package_type", - "visibility", - "url", - "html_url", - "version_count", - "created_at", - "updated_at" - ] + "date" + ], + "additionalProperties": true } }, "examples": { "default": { "value": [ { - "id": 197, - "name": "hello_docker", - "package_type": "container", - "owner": { - "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 + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] }, - "version_count": 1, - "visibility": "private", - "url": "https://api.github.com/orgs/github/packages/container/hello_docker", - "created_at": "2020-05-19T22:19:11Z", - "updated_at": "2020-05-19T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" - }, - { - "id": 198, - "name": "goodbye_docker", - "package_type": "container", - "owner": { - "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 + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] }, - "version_count": 2, - "visibility": "private", - "url": "https://api.github.com/orgs/github/packages/container/goodbye_docker", - "created_at": "2020-05-20T22:19:11Z", - "updated_at": "2020-05-20T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/package/goodbye_docker" + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } } ] } @@ -132945,6 +132538,32 @@ } } }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, "403": { "description": "Forbidden", "content": { @@ -132971,8 +132590,34 @@ } } }, - "401": { - "description": "Requires authentication", + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Copilot Usage Metrics API setting is disabled at the organization or enterprise level.", "content": { "application/json": { "schema": { @@ -133000,23 +132645,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "packages", - "subcategory": "packages" + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" } } }, - "/orgs/{org}/events": { + "/orgs/{org}/copilot/metrics/reports/organization-1-day": { "get": { - "summary": "List public organization events", - "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", + "summary": "Get Copilot organization usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", "tags": [ - "activity" + "copilot" ], - "operationId": "activity/list-public-org-events", + "operationId": "copilot/copilot-organization-one-day-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/activity/events#list-public-organization-events" + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day" }, "parameters": [ { @@ -133029,21 +132674,172 @@ } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", "in": "query", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + } + } + } + } + }, + "204": { + "description": "A header with no content is returned." + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } } }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest": { + "get": { + "summary": "Get Copilot organization usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics" + }, + "parameters": [ { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "string" } } ], @@ -133053,4504 +132849,3027 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Event", - "description": "Event", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": [ - "string", - "null" - ] - }, - "actor": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "name", - "url" - ] + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/users-1-day": { + "get": { + "summary": "Get Copilot organization users usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-users-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" }, - "org": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + } + } + } + } + }, + "204": { + "description": "A header with no content is returned." + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/users-28-day/latest": { + "get": { + "summary": "Get Copilot organization users usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-users-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" }, - "payload": { - "oneOf": [ - { - "title": "CreateEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "full_ref": { - "type": "string" - }, - "master_branch": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "full_ref", - "master_branch", - "pusher_type" - ] - }, - { - "title": "DeleteEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "full_ref": { - "type": "string" - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "full_ref", - "pusher_type" - ] - }, - { - "title": "DiscussionEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "discussion": { - "title": "Discussion", - "description": "A Discussion in a repository.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/dependabot/alerts": { + "get": { + "summary": "List Dependabot alerts for an organization", + "description": "Lists Dependabot alerts for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/list-alerts-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "classification", + "in": "query", + "description": "A comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned.\n\nCan be: `malware`, `general`", + "schema": { + "type": "string" + } + }, + { + "name": "state", + "in": "query", + "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`", + "schema": { + "type": "string" + } + }, + { + "name": "severity", + "in": "query", + "description": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`", + "schema": { + "type": "string" + } + }, + { + "name": "ecosystem", + "in": "query", + "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`", + "schema": { + "type": "string" + } + }, + { + "name": "package", + "in": "query", + "description": "A comma-separated list of package names. If specified, only alerts for these packages will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentage", + "in": "query", + "description": "CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "artifact_registry_url", + "in": "query", + "description": "A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "artifact_registry", + "in": "query", + "description": "A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned.\n\nCan be: `jfrog-artifactory`", + "schema": { + "type": "string" + } + }, + { + "name": "has", + "in": "query", + "description": "Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple `has` filters can be passed to filter for alerts that have all of the values.", + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "patch", + "deployment" + ] + } + } + ] + } + }, + { + "name": "assignee", + "in": "query", + "description": "Filter alerts by assignees.\nProvide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users.\nUse `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.", + "schema": { + "type": "string" + } + }, + { + "name": "runtime_risk", + "in": "query", + "description": "A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned.\n\nCan be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement`", + "schema": { + "type": "string" + } + }, + { + "name": "scope", + "in": "query", + "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.", + "schema": { + "type": "string", + "enum": [ + "development", + "runtime" + ] + } + }, + { + "name": "sort", + "in": "query", + "description": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.", + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "epss_percentage" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "description": "A Dependabot alert.", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "state": { + "type": "string", + "description": "The state of the Dependabot alert.", + "readOnly": true, + "enum": [ + "auto_dismissed", + "dismissed", + "fixed", + "open" + ] + }, + "dependency": { + "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true + }, + "scope": { + "type": [ + "string", + "null" + ], + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "enum": [ + "development", + "runtime", + null + ] + }, + "relationship": { + "type": [ + "string", + "null" + ], + "description": "The vulnerable dependency's relationship to your project.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.\n", + "readOnly": true, + "enum": [ + "unknown", + "direct", + "transitive", + "inconclusive", + null + ] + } + } + }, + "security_advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { + "type": "string", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true + }, + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true + }, + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true }, - "required": [ - "login", - "id" - ] + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } }, - "answer_html_url": { + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + } + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "classification": { + "type": "string", + "description": "The classification of the advisory.", + "readOnly": true, + "enum": [ + "general", + "malware" + ] + }, + "cvss_severities": { + "type": [ + "object", + "null" + ], + "properties": { + "cvss_v3": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { "type": [ "string", "null" - ] - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] - }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "locked": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" - }, - "state": { - "type": "string", - "description": "The current state of the discussion.\n`converting` means that the discussion is being converted from an issue.\n`transferring` means that the discussion is being transferred from another repository.", - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] + ], + "description": "The CVSS 3 vector string." }, - "state_reason": { - "description": "The reason for the current state", + "score": { "type": [ - "string", + "number", "null" ], - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" ], - "examples": [ - "resolved" - ] - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" + "description": "The CVSS 4 vector string." }, - "user": { - "title": "User", + "score": { "type": [ - "object", + "number", "null" ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64", - "examples": [ - 208045946 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDU6TGFiZWwyMDgwNDU5NDY=" - ] - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/labels/bug" - ] - }, - "name": { - "description": "The name of the label.", - "type": "string", - "examples": [ - "bug" - ] - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ], - "examples": [ - "Something isn't working" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string", - "examples": [ - "FFFFFF" - ] - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "examples": [ - true - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "readOnly": true } }, "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "state_reason", - "locked", - "comments", - "created_at", - "updated_at", - "active_lock_reason", - "body" + "vector_string", + "score" ] } + } + }, + "epss": { + "type": [ + "object", + "null" + ], + "readOnly": true, + "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", + "properties": { + "percentage": { + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "percentile": { + "type": "number", + "minimum": 0, + "maximum": 100 + } + } + }, + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } + }, + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + } + }, + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } + }, + "required": [ + "url" + ], + "additionalProperties": false + } + }, + "published_at": { + "type": "string", + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + }, + "required": [ + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" + ], + "additionalProperties": false + }, + "security_vulnerability": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } }, "required": [ - "action", - "discussion" + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" ] }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" + }, { - "title": "IssuesEvent", + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "action": { - "type": "string" + "name": { + "type": [ + "string", + "null" + ] }, - "issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/1" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], - "examples": [ - "not_planned" - ] - }, - "title": { - "description": "Title of the issue", - "type": "string", - "examples": [ - "Widget creation fails in Safari on OS X 10.8" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ], - "examples": [ - "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - }, - "examples": [ - "bug", - "registration" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "dismissed_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason that the alert was dismissed.", + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment associated with the alert's dismissal.", + "maxLength": 280 + }, + "fixed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "auto_dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissal_request": { + "title": "Dependabot alert dismissal request", + "description": "Information about an active dismissal request for this Dependabot alert.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the dismissal request." + }, + "status": { + "type": "string", + "description": "The current status of the dismissal request.", + "enum": [ + "pending", + "approved", + "rejected", + "cancelled" + ] + }, + "requester": { + "type": "object", + "description": "The user who requested the dismissal.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the user." + }, + "login": { + "type": "string", + "description": "The login name of the user." + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time when the dismissal request was created." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The API URL to get more information about this dismissal request." + } + } + }, + "assignees": { + "type": "array", + "description": "The users assigned to this alert.", + "readOnly": true, + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } + }, + "required": [ + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", + "url", + "html_url", + "created_at", + "updated_at", + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at", + "repository" + ], + "additionalProperties": false + } + }, + "examples": { + "default": { + "value": [ + { + "number": 2, + "state": "dismissed", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-rf4j-j272-fj86", + "cve_id": "CVE-2018-6188", + "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", + "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 1.11.8, < 1.11.10", + "first_patched_version": { + "identifier": "1.11.10" + } + } + ], + "severity": "high", + "cvss": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, + "cwes": [ + { + "cwe_id": "CWE-200", + "name": "Exposure of Sensitive Information to an Unauthorized Actor" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-rf4j-j272-fj86" + }, + { + "type": "CVE", + "value": "CVE-2018-6188" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" + }, + { + "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" + }, + { + "url": "https://usn.ubuntu.com/3559-1/" + }, + { + "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" + }, + { + "url": "http://www.securitytracker.com/id/1040422" + } + ], + "published_at": "2018-10-03T21:13:54Z", + "updated_at": "2022-04-26T18:35:37Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + "url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2", + "html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2", + "created_at": "2022-06-15T07:43:03Z", + "updated_at": "2022-08-23T14:29:47Z", + "dismissed_at": "2022-08-23T14:29:47Z", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_reason": "tolerable_risk", + "dismissed_comment": "This alert is accurate but we use a sanitizer.", + "fixed_at": null, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "repository": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "owner": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "private": true, + "html_url": "https://github.com/octo-org/octo-repo", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}" + } + }, + { + "number": 1, + "state": "open", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-8f4m-hccc-8qph", + "cve_id": "CVE-2021-20191", + "summary": "Insertion of Sensitive Information into Log File in ansible", + "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.9.0, < 2.9.18", + "first_patched_version": { + "identifier": "2.9.18" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.10.0, < 2.10.7", + "first_patched_version": { + "identifier": "2.10.7" + } + } + ], + "severity": "medium", + "cvss": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, + "cwes": [ + { + "cwe_id": "CWE-532", + "name": "Insertion of Sensitive Information into Log File" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-8f4m-hccc-8qph" + }, + { + "type": "CVE", + "value": "CVE-2021-20191" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" + }, + { + "url": "https://access.redhat.com/security/cve/cve-2021-20191" + }, + { + "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" + } + ], + "published_at": "2021-06-01T17:38:00Z", + "updated_at": "2021-08-12T23:06:00Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + "url": "https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1", + "html_url": "https://github.com/octo-org/hello-world/security/dependabot/1", + "created_at": "2022-06-14T15:21:52Z", + "updated_at": "2022-06-14T15:21:52Z", + "dismissed_at": null, + "dismissed_by": null, + "dismissed_reason": null, + "dismissed_comment": null, + "fixed_at": null, + "assignees": [], + "repository": { + "id": 664700648, + "node_id": "MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=", + "name": "hello-world", + "full_name": "octo-org/hello-world", + "owner": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "private": true, + "html_url": "https://github.com/octo-org/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/hello-world", + "archive_url": "https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/hello-world/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/hello-world/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/hello-world/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/hello-world/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/hello-world/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/hello-world/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/hello-world/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/hello-world/downloads", + "events_url": "https://api.github.com/repos/octo-org/hello-world/events", + "forks_url": "https://api.github.com/repos/octo-org/hello-world/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/hello-world/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/hello-world/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/hello-world/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/hello-world/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/hello-world/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/hello-world/languages", + "merges_url": "https://api.github.com/repos/octo-org/hello-world/merges", + "milestones_url": "https://api.github.com/repos/octo-org/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/hello-world/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/hello-world/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/hello-world/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/hello-world/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/hello-world/subscription", + "tags_url": "https://api.github.com/repos/octo-org/hello-world/tags", + "teams_url": "https://api.github.com/repos/octo-org/hello-world/teams", + "trees_url": "https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}" + } + } + ] + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "alerts" + } + } + }, + "/orgs/{org}/dependabot/repository-access": { + "get": { + "summary": "Lists the repositories Dependabot can access in an organization", + "description": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/repository-access-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "in": "query", + "description": "The page number of results to fetch.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "default": 1 + } + }, + { + "name": "per_page", + "in": "query", + "description": "Number of results per page.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", + "type": "object", + "properties": { + "default_level": { + "type": [ + "string", + "null" + ], + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal", + null + ], + "examples": [ + "internal" + ] + }, + "accessible_repositories": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "nullable": false - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "nullable": false - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "nullable": false - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "nullable": false - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "nullable": false - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" + "email": { + "type": [ + "string", + "null" ] }, - "closed_at": { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ "string", "null" ], - "format": "date-time" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "created_at": { + "url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "draft": { - "type": "boolean" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "body_html": { - "type": "string" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "body_text": { - "type": "string" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "timeline_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ], - "examples": [ - "all" - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" + "type": "string", + "examples": [ + "User" ] }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] + "site_admin": { + "type": "boolean" }, - "author_association": { - "title": "author_association", + "starred_at": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], "examples": [ - "OWNER" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "\"2020-07-09T00:17:55Z\"" ] }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the issue comment", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/comments/1" - ] - }, - "body": { - "description": "Contents of the issue comment", - "type": "string", - "examples": [ - "What version of Safari were you using when you observed this bug?" - ] - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] - }, - { - "type": "number", - "examples": [ - 42.5 - ] - }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] - }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "required": [ - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "created_at", - "updated_at" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, @@ -137575,998 +135894,9447 @@ "url" ] }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "private": { + "type": "boolean", + "description": "Whether the repository is private." }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64", - "examples": [ - 208045946 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDU6TGFiZWwyMDgwNDU5NDY=" - ] - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/labels/bug" - ] - }, - "name": { - "description": "The name of the label.", - "type": "string", - "examples": [ - "bug" - ] - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ], - "examples": [ - "Something isn't working" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string", - "examples": [ - "FFFFFF" - ] - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "examples": [ - true - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" ] }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64", - "examples": [ - 208045946 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDU6TGFiZWwyMDgwNDU5NDY=" - ] - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/labels/bug" - ] - }, - "name": { - "description": "The name of the label.", - "type": "string", - "examples": [ - "bug" - ] - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ], - "examples": [ - "Something isn't working" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string", - "examples": [ - "FFFFFF" - ] - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "examples": [ - true - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] } }, "required": [ - "action", - "issue" + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] + } + ] + } + } + }, + "additionalProperties": false + }, + "examples": { + "default": { + "value": { + "default_level": "public", + "accessible_repositories": [ + { + "id": 123456, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", + "name": "example-repo", + "full_name": "octocat/example-repo", + "owner": { + "name": "octocat", + "email": "octo@github.com", + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", + "gravatar_id": 1, + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat/example-repo", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "starred_at": "\"2020-07-09T00:17:55Z\"", + "user_view_type": "default" }, - { - "title": "IssueCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/1" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], - "examples": [ - "not_planned" - ] - }, - "title": { - "description": "Title of the issue", - "type": "string", - "examples": [ - "Widget creation fails in Safari on OS X 10.8" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ], - "examples": [ - "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - }, - "examples": [ - "bug", - "registration" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ + "private": false, + "html_url": "https://github.com/octocat/example-repo", + "description": "This is an example repository.", + "fork": false, + "url": "https://api.github.com/repos/octocat/example-repo", + "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", + "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", + "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", + "events_url": "https://api.github.com/repos/octocat/example-repo/events", + "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", + "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", + "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", + "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", + "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", + "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", + "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + } + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" + } + }, + "patch": { + "summary": "Updates Dependabot's repository access list for an organization", + "description": "Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.\n\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/update-repository-access-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repository_ids_to_add": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to add." + }, + "repository_ids_to_remove": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to remove." + } + }, + "example": { + "repository_ids_to_add": [ + 123, + 456 + ], + "repository_ids_to_remove": [ + 789 + ] + } + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status." + }, + "add-example": { + "summary": "Add repositories", + "value": { + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, + "/orgs/{org}/dependabot/repository-access/default-level": { + "put": { + "summary": "Set the default repository access level for Dependabot", + "description": "Sets the default level of repository access Dependabot will have while performing an update. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.\n\nThis operation supports both server-to-server and user-to-server access.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/set-repository-access-default-level", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "examples": [ + "internal" + ] + } + }, + "required": [ + "default_level" + ] + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status.", + "value": { + "default_level": "public" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, + "/orgs/{org}/dependabot/secrets": { + "get": { + "summary": "List organization secrets", + "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/list-org-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#list-organization-secrets" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "title": "Dependabot Secret for an Organization", + "description": "Secrets for GitHub Dependabot for an organization.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" + ] + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 3, + "secrets": [ + { + "name": "MY_ARTIFACTORY_PASSWORD", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "private" + }, + { + "name": "NPM_TOKEN", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "GH_TOKEN", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/dependabot/secrets/public-key": { + "get": { + "summary": "Get an organization public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "DependabotPublicKey", + "description": "The public key used for setting Dependabot Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "examples": [ + "1234567" + ] + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "examples": [ + "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + ] + } + }, + "required": [ + "key_id", + "key" + ] + }, + "examples": { + "default": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/dependabot/secrets/{secret_name}": { + "get": { + "summary": "Get an organization secret", + "description": "Gets a single organization secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/get-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Dependabot Secret for an Organization", + "description": "Secrets for GitHub Dependabot for an organization.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" + ] + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "NPM_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/create-or-update-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + }, + "visibility": { + "type": "string", + "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Delete an organization secret", + "description": "Deletes a secret in an organization using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/delete-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { + "get": { + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/list-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "has_pull_requests": { + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + }, + "mode": { + "type": "string", + "description": "The bypass mode for the reviewer", + "enum": [ + "ALWAYS", + "EXEMPT" + ], + "default": "ALWAYS" + } + } + } + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Set selected repositories for an organization secret", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/set-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization secret", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/add-selected-repo-to-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "No Content when repository was added to the selected list" + }, + "409": { + "description": "Conflict when visibility type is not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Remove selected repository from an organization secret", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/remove-selected-repo-from-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response when repository was removed from the selected list" + }, + "409": { + "description": "Conflict when visibility type not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/docker/conflicts": { + "get": { + "summary": "Get list of conflicting packages during Docker migration for organization", + "description": "Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", + "tags": [ + "packages" + ], + "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Package", + "description": "A software package", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the package.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the package.", + "type": "string", + "examples": [ + "super-linter" + ] + }, + "package_type": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ], + "examples": [ + "docker" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/packages/container/super-linter" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "https://github.com/orgs/github/packages/container/package/super-linter" + ] + }, + "version_count": { + "description": "The number of versions of the package.", + "type": "integer", + "examples": [ + 1 + ] + }, + "visibility": { + "type": "string", + "enum": [ + "private", + "public" + ], + "examples": [ + "private" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "repository": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "has_pull_requests": { + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + }, + "mode": { + "type": "string", + "description": "The bypass mode for the reviewer", + "enum": [ + "ALWAYS", + "EXEMPT" + ], + "default": "ALWAYS" + } + } + } + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "name", + "package_type", + "visibility", + "url", + "html_url", + "version_count", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 197, + "name": "hello_docker", + "package_type": "container", + "owner": { + "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 + }, + "version_count": 1, + "visibility": "private", + "url": "https://api.github.com/orgs/github/packages/container/hello_docker", + "created_at": "2020-05-19T22:19:11Z", + "updated_at": "2020-05-19T22:19:11Z", + "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" + }, + { + "id": 198, + "name": "goodbye_docker", + "package_type": "container", + "owner": { + "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 + }, + "version_count": 2, + "visibility": "private", + "url": "https://api.github.com/orgs/github/packages/container/goodbye_docker", + "created_at": "2020-05-20T22:19:11Z", + "updated_at": "2020-05-20T22:19:11Z", + "html_url": "https://github.com/orgs/github/packages/container/package/goodbye_docker" + } + ] + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/orgs/{org}/events": { + "get": { + "summary": "List public organization events", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", + "tags": [ + "activity" + ], + "operationId": "activity/list-public-org-events", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/events#list-public-organization-events" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Event", + "description": "Event", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": [ + "string", + "null" + ] + }, + "actor": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "name", + "url" + ] + }, + "org": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] + }, + "payload": { + "oneOf": [ + { + "title": "CreateEvent", + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "ref_type": { + "type": "string" + }, + "full_ref": { + "type": "string" + }, + "master_branch": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "pusher_type": { + "type": "string" + } + }, + "required": [ + "ref", + "ref_type", + "full_ref", + "master_branch", + "pusher_type" + ] + }, + { + "title": "DeleteEvent", + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "ref_type": { + "type": "string" + }, + "full_ref": { + "type": "string" + }, + "pusher_type": { + "type": "string" + } + }, + "required": [ + "ref", + "ref_type", + "full_ref", + "pusher_type" + ] + }, + { + "title": "DiscussionEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "discussion": { + "title": "Discussion", + "description": "A Discussion in a repository.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "answer_html_url": { + "type": [ + "string", + "null" + ] + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "type": "string" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "description": "The current state of the discussion.\n`converting` means that the discussion is being converted from an issue.\n`transferring` means that the discussion is being transferred from another repository.", + "enum": [ + "open", + "closed", + "locked", + "converting", + "transferring" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "outdated", + "duplicate", + "reopened", + null + ], + "examples": [ + "resolved" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "examples": [ + 208045946 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDU6TGFiZWwyMDgwNDU5NDY=" + ] + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/labels/bug" + ] + }, + "name": { + "description": "The name of the label.", + "type": "string", + "examples": [ + "bug" + ] + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": [ + "string", + "null" + ], + "examples": [ + "Something isn't working" + ] + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string", + "examples": [ + "FFFFFF" + ] + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "state_reason", + "locked", + "comments", + "created_at", + "updated_at", + "active_lock_reason", + "body" + ] + } + }, + "required": [ + "action", + "discussion" + ] + }, + { + "title": "IssuesEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "nullable": false + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "nullable": false + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "nullable": false + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "nullable": false + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "nullable": false + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ], + "examples": [ + "all" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "parent_issue_url": { + "description": "URL to get the parent issue of this issue, if it is a sub-issue", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "pinned_comment": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/comments/1" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string", + "examples": [ + "What version of Safari were you using when you observed this bug?" + ] + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "pinned_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "pinned_at", + "pinned_by" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "examples": [ + "Sample text" + ] + }, + { + "type": "number", + "examples": [ + 42.5 + ] + }, + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the option", + "type": "string", + "examples": [ + "High" + ] + }, + "color": { + "description": "The color of the option", + "type": "string", + "examples": [ + "red" + ] + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + } + }, + "required": [ + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "created_at", + "updated_at" + ] + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "label": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "examples": [ + 208045946 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDU6TGFiZWwyMDgwNDU5NDY=" + ] + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/labels/bug" + ] + }, + "name": { + "description": "The name of the label.", + "type": "string", + "examples": [ + "bug" + ] + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": [ + "string", + "null" + ], + "examples": [ + "Something isn't working" + ] + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string", + "examples": [ + "FFFFFF" + ] + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "examples": [ + 208045946 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDU6TGFiZWwyMDgwNDU5NDY=" + ] + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/labels/bug" + ] + }, + "name": { + "description": "The name of the label.", + "type": "string", + "examples": [ + "bug" + ] + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": [ + "string", + "null" + ], + "examples": [ + "Something isn't working" + ] + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string", + "examples": [ + "FFFFFF" + ] + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + } + }, + "required": [ + "action", + "issue" + ] + }, + { + "title": "IssueCommentEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ "https://api.github.com/users/octocat/orgs" ] }, @@ -150523,7 +157291,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -151678,7 +158446,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -261071,6 +267839,14 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether the repository has opted in to the immutable OIDC subject claim format. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim. If not set at the repository level, falls back to the organization-level setting.", + "type": "boolean" + }, + "sub_claim_prefix": { + "description": "The current `sub` claim prefix for this repository.", + "type": "string" } }, "required": [ @@ -261246,6 +268022,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for this repository. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim.", + "type": "boolean" } } }, @@ -282130,7 +288910,7 @@ ], "responses": { "200": { - "description": "Response including the workflow run ID and URLs when `return_run_details` parameter is `true`.", + "description": "Response including the workflow run ID and URLs.", "content": { "application/json": { "schema": { @@ -418070,7 +424850,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -614675,6 +621455,18 @@ "string", "null" ] + }, + "validity": { + "type": [ + "string", + "null" + ], + "enum": [ + "active", + "inactive", + null + ], + "description": "Sets the validity of the secret scanning alert. Can be `active`, `inactive`, or `null` to clear the override." } }, "anyOf": [ @@ -616271,7 +623063,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" + "description": "State does not match the resolution or resolution comment, assignee does not have write access to the repository, or the requested validity change could not be applied to this alert" }, "503": { "description": "Service unavailable", @@ -693377,7 +700169,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -717406,417 +724198,2437 @@ "disabled" ] } - } - }, - "secret_scanning_delegated_bypass": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] + } + }, + "secret_scanning_delegated_bypass": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + }, + "mode": { + "type": "string", + "description": "The bypass mode for the reviewer", + "enum": [ + "ALWAYS", + "EXEMPT" + ], + "default": "ALWAYS" + } + } + } + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "has_discussions", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at", + "network_count", + "subscribers_count" + ] + }, + "examples": { + "default": { + "value": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "language": null, + "forks_count": 9, + "forks": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "open_issues": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "pull": true, + "push": false, + "admin": false + }, + "allow_rebase_merge": true, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "allow_forking": true, + "web_commit_signoff_required": false, + "subscribers_count": 42, + "network_count": 0, + "organization": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "Organization", + "site_admin": false + }, + "parent": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "source": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World", + "schema": { + "type": "string" + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "451": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "repos", + "subcategory": "repos" + } + } + }, + "/user/repository_invitations": { + "get": { + "summary": "List repository invitations for the authenticated user", + "description": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user.", + "tags": [ + "repos" + ], + "operationId": "repos/list-invitations-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Repository Invitation", + "description": "Repository invitations let you manage who you collaborate with.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository invitation.", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "has_pull_requests": { + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + } } - } - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { + "status": { "type": "string", - "description": "The type of the bypass reviewer", "enum": [ - "TEAM", - "ROLE" + "enabled", + "disabled" ] - }, - "mode": { + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { "type": "string", - "description": "The bypass mode for the reviewer", "enum": [ - "ALWAYS", - "EXEMPT" - ], - "default": "ALWAYS" + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + }, + "mode": { + "type": "string", + "description": "The bypass mode for the reviewer", + "enum": [ + "ALWAYS", + "EXEMPT" + ], + "default": "ALWAYS" + } + } + } } } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } - } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "invitee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "inviter": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "permissions": { + "description": "The permission associated with the invitation.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "triage", + "maintain" + ], + "examples": [ + "read" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-06-13T14:52:50-05:00" + ] + }, + "expired": { + "description": "Whether or not the invitation has expired", + "type": "boolean" + }, + "url": { + "description": "URL for the repository invitation", + "type": "string", + "examples": [ + "https://api.github.com/user/repository-invitations/1" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World/invitations" + ] + }, + "node_id": { + "type": "string" } }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at", - "network_count", - "subscribers_count" - ] + "required": [ + "id", + "node_id", + "permissions", + "inviter", + "invitee", + "repository", + "url", + "html_url", + "created_at" + ] + } }, "examples": { "default": { - "value": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", + "value": [ + { "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://github.com/licenses/mit" - }, - "language": null, - "forks_count": 9, - "forks": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "open_issues": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "pull": true, - "push": false, - "admin": false - }, - "allow_rebase_merge": true, - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World-Template", - "full_name": "octocat/Hello-World-Template", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World-Template", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World-Template", - "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World-Template.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World-Template.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World-Template.git", - "mirror_url": "git:git.example.com/octocat/Hello-World-Template", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World-Template", - "homepage": "https://github.com", - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "allow_forking": true, - "web_commit_signoff_required": false, - "subscribers_count": 42, - "network_count": 0, - "organization": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "Organization", - "site_admin": false - }, - "parent": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { + "invitee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -717836,109 +726648,7 @@ "type": "User", "site_admin": false }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - }, - "source": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { + "inviter": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -717958,119 +726668,775 @@ "type": "User", "site_admin": false }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" + "permissions": "write", + "created_at": "2016-06-13T14:52:50-05:00", + "url": "https://api.github.com/user/repository_invitations/1296269", + "html_url": "https://github.com/octocat/Hello-World/invitations", + "node_id": "MDQ6VXNlcjE=" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "collaborators", + "subcategory": "invitations" + } + } + }, + "/user/repository_invitations/{invitation_id}": { + "patch": { + "summary": "Accept a repository invitation", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/accept-invitation-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation" + }, + "parameters": [ + { + "name": "invitation_id", + "description": "The unique identifier of the invitation.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "451": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "collaborators", + "subcategory": "invitations" + } + }, + "delete": { + "summary": "Decline a repository invitation", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/decline-invitation-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation" + }, + "parameters": [ + { + "name": "invitation_id", + "description": "The unique identifier of the invitation.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "collaborators", + "subcategory": "invitations" + } + } + }, + "/user/social_accounts": { + "get": { + "summary": "List social accounts for the authenticated user", + "description": "Lists all of your social accounts.", + "tags": [ + "users" + ], + "operationId": "users/list-social-accounts-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Social account", + "description": "Social media account", + "type": "object", + "properties": { + "provider": { + "type": "string", + "examples": [ + "linkedin" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://www.linkedin.com/company/github/" + ] + } + }, + "required": [ + "provider", + "url" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "provider": "twitter", + "url": "https://twitter.com/github" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "social-accounts" + } + }, + "post": { + "summary": "Add social accounts for the authenticated user", + "description": "Add one or more social accounts to the authenticated user's profile.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/add-social-account-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user" + }, + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "account_urls": { + "description": "Full URLs for the social media profiles to add.", + "type": "array", + "items": { + "type": "string", + "examples": [ + "https://twitter.com/github" + ] + }, + "examples": [] + } + }, + "required": [ + "account_urls" + ], + "example": { + "account_urls": [ + "https://www.linkedin.com/company/github/", + "https://twitter.com/github" + ] + } + }, + "examples": { + "default": { + "summary": "Adding multiple social accounts", + "value": { + "account_urls": [ + "https://facebook.com/GitHub", + "https://www.youtube.com/@GitHub" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Social account", + "description": "Social media account", + "type": "object", + "properties": { + "provider": { + "type": "string", + "examples": [ + "linkedin" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://www.linkedin.com/company/github/" + ] } - } + }, + "required": [ + "provider", + "url" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "provider": "twitter", + "url": "https://twitter.com/github" + } + ] } } } - }, - "headers": { - "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World", + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } } } } }, - "401": { - "description": "Requires authentication", + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -718095,11 +727461,8 @@ } } }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -718124,8 +727487,8 @@ } } }, - "403": { - "description": "Forbidden", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -718149,6 +727512,73 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "social-accounts" + } + }, + "delete": { + "summary": "Delete social accounts for the authenticated user", + "description": "Deletes one or more social accounts from the authenticated user's profile.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/delete-social-account-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user" + }, + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "account_urls": { + "description": "Full URLs for the social media profiles to delete.", + "type": "array", + "items": { + "type": "string", + "examples": [ + "https://twitter.com/github" + ] + }, + "examples": [] + } + }, + "required": [ + "account_urls" + ], + "example": { + "account_urls": [ + "https://www.linkedin.com/company/github/", + "https://twitter.com/github" + ] + } + }, + "examples": { + "default": { + "summary": "Deleting multiple social accounts", + "value": { + "account_urls": [ + "https://facebook.com/GitHub", + "https://www.youtube.com/@GitHub" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" }, "422": { "description": "Validation failed, or the endpoint has been spammed.", @@ -718225,8 +727655,11 @@ } } }, - "400": { - "description": "Bad Request", + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -718248,52 +727681,347 @@ } } } - }, - "application/scim+json": { + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { "schema": { - "title": "Scim Error", - "description": "Scim Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { "message": { - "type": [ - "string", - "null" - ] + "type": "string" }, "documentation_url": { - "type": [ - "string", - "null" - ] + "type": "string" }, - "detail": { - "type": [ - "string", - "null" - ] + "url": { + "type": "string" }, "status": { - "type": "integer" + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "scimType": { - "type": [ - "string", - "null" - ] + "documentation_url": { + "type": "string" }, - "schemas": { - "type": "array", - "items": { + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "social-accounts" + } + } + }, + "/user/ssh_signing_keys": { + "get": { + "summary": "List SSH signing keys for the authenticated user", + "description": "Lists the SSH signing keys for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/list-ssh-signing-keys-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "SSH Signing Key", + "description": "A public SSH key used to sign Git commits", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "title": { "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "title", + "created_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 2, + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + }, + { + "id": 3, + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", + "created_at": "2020-07-11T21:31:57Z" } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } }, - "451": { + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "ssh-signing-keys" + } + }, + "post": { + "summary": "Create a SSH signing key for the authenticated user", + "description": "Creates an SSH signing key for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint.", + "operationId": "users/create-ssh-signing-key-for-authenticated-user", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user" + }, + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "A descriptive name for the new key.", + "type": "string", + "examples": [ + "Personal MacBook Air" + ] + }, + "key": { + "description": "The public SSH key to add to your GitHub account. For more information, see \"[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).\"", + "type": "string", + "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com " + } + }, + "required": [ + "key" + ], + "type": "object" + }, + "examples": { + "default": { + "value": { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "SSH Signing Key", + "description": "A public SSH key used to sign Git commits", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "title", + "created_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + } + } + } + } + } + }, + "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { @@ -718319,126 +728047,1588 @@ "required": [ "code" ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "ssh-signing-keys" + } + } + }, + "/user/ssh_signing_keys/{ssh_signing_key_id}": { + "get": { + "summary": "Get an SSH signing key for the authenticated user", + "description": "Gets extended details for an SSH signing key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/get-ssh-signing-key-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "ssh_signing_key_id", + "description": "The unique identifier of the SSH signing key.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "SSH Signing Key", + "description": "A public SSH key used to sign Git commits", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "title", + "created_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "ssh-signing-keys" + } + }, + "delete": { + "summary": "Delete an SSH signing key for the authenticated user", + "description": "Deletes an SSH signing key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/delete-ssh-signing-key-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "ssh_signing_key_id", + "description": "The unique identifier of the SSH signing key.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "ssh-signing-keys" + } + } + }, + "/user/starred": { + "get": { + "summary": "List repositories starred by the authenticated user", + "description": "Lists repositories the authenticated user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", + "tags": [ + "activity" + ], + "operationId": "activity/list-repos-starred-by-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user" + }, + "parameters": [ + { + "name": "sort", + "description": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ], + "examples": [ + "all" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default-response": { + "summary": "Default response", + "value": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 } - } + ] } } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "repos", - "subcategory": "repos" - } - } - }, - "/user/repository_invitations": { - "get": { - "summary": "List repository invitations for the authenticated user", - "description": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user.", - "tags": [ - "repos" - ], - "operationId": "repos/list-invitations-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user" - }, - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { + }, + "application/vnd.github.v3.star+json": { "schema": { "type": "array", "items": { - "title": "Repository Invitation", - "description": "Repository invitations let you manage who you collaborate with.", + "title": "Starred Repository", + "description": "Starred Repository", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository invitation.", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] + "starred_at": { + "type": "string", + "format": "date-time" }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "repo": { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "examples": [ - 1296269 + 42 ] }, "node_id": { @@ -718448,9 +729638,10 @@ ] }, "name": { + "description": "The name of the repository.", "type": "string", "examples": [ - "Hello-World" + "Team Environment" ] }, "full_name": { @@ -718459,6 +729650,96 @@ "octocat/Hello-World" ] }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, "owner": { "title": "Simple User", "description": "A GitHub user.", @@ -718628,6 +729909,8 @@ ] }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -718764,7 +730047,10 @@ ] }, "git_url": { - "type": "string" + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] }, "issue_comment_url": { "type": "string", @@ -718835,7 +730121,10 @@ ] }, "ssh_url": { - "type": "string" + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] }, "stargazers_url": { "type": "string", @@ -718885,12 +730174,19 @@ ] }, "clone_url": { - "type": "string" + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] }, "mirror_url": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { @@ -718901,12 +730197,20 @@ ] }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] }, "homepage": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "https://github.com" ] }, "language": { @@ -718916,26 +730220,50 @@ ] }, "forks_count": { - "type": "integer" + "type": "integer", + "examples": [ + 9 + ] }, "stargazers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "watchers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" + "type": "integer", + "examples": [ + 108 + ] }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] }, "open_issues_count": { - "type": "integer" + "type": "integer", + "examples": [ + 0 + ] }, "is_template": { - "type": "boolean" + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] }, "topics": { "type": "array", @@ -718944,22 +730272,47 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_pages": { "type": "boolean" }, "has_discussions": { - "type": "boolean" + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] }, "has_pull_requests": { - "type": "boolean" + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", @@ -718967,1931 +730320,407 @@ "enum": [ "all", "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", "examples": [ - 0 + "all" ] }, - "allow_forking": { + "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_bypass": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - }, - "mode": { - "type": "string", - "description": "The bypass mode for the reviewer", - "enum": [ - "ALWAYS", - "EXEMPT" - ], - "default": "ALWAYS" - } - } - } - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - }, - "invitee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "inviter": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "permissions": { - "description": "The permission associated with the invitation.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "triage", - "maintain" - ], - "examples": [ - "read" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-06-13T14:52:50-05:00" - ] - }, - "expired": { - "description": "Whether or not the invitation has expired", - "type": "boolean" - }, - "url": { - "description": "URL for the repository invitation", - "type": "string", - "examples": [ - "https://api.github.com/user/repository-invitations/1" - ] - }, - "html_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World/invitations" - ] - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "permissions", - "inviter", - "invitee", - "repository", - "url", - "html_url", - "created_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "invitee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "inviter": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "permissions": "write", - "created_at": "2016-06-13T14:52:50-05:00", - "url": "https://api.github.com/user/repository_invitations/1296269", - "html_url": "https://github.com/octocat/Hello-World/invitations", - "node_id": "MDQ6VXNlcjE=" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "collaborators", - "subcategory": "invitations" - } - } - }, - "/user/repository_invitations/{invitation_id}": { - "patch": { - "summary": "Accept a repository invitation", - "description": "", - "tags": [ - "repos" - ], - "operationId": "repos/accept-invitation-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation" - }, - "parameters": [ - { - "name": "invitation_id", - "description": "The unique identifier of the invitation.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "451": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "collaborators", - "subcategory": "invitations" - } - }, - "delete": { - "summary": "Decline a repository invitation", - "description": "", - "tags": [ - "repos" - ], - "operationId": "repos/decline-invitation-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation" - }, - "parameters": [ - { - "name": "invitation_id", - "description": "The unique identifier of the invitation.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "collaborators", - "subcategory": "invitations" - } - } - }, - "/user/social_accounts": { - "get": { - "summary": "List social accounts for the authenticated user", - "description": "Lists all of your social accounts.", - "tags": [ - "users" - ], - "operationId": "users/list-social-accounts-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user" - }, - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Social account", - "description": "Social media account", - "type": "object", - "properties": { - "provider": { - "type": "string", - "examples": [ - "linkedin" - ] - }, - "url": { - "type": "string", - "examples": [ - "https://www.linkedin.com/company/github/" - ] - } - }, - "required": [ - "provider", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "provider": "twitter", - "url": "https://twitter.com/github" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "users", - "subcategory": "social-accounts" - } - }, - "post": { - "summary": "Add social accounts for the authenticated user", - "description": "Add one or more social accounts to the authenticated user's profile.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", - "tags": [ - "users" - ], - "operationId": "users/add-social-account-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user" - }, - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "account_urls": { - "description": "Full URLs for the social media profiles to add.", - "type": "array", - "items": { - "type": "string", - "examples": [ - "https://twitter.com/github" - ] - }, - "examples": [] - } - }, - "required": [ - "account_urls" - ], - "example": { - "account_urls": [ - "https://www.linkedin.com/company/github/", - "https://twitter.com/github" - ] - } - }, - "examples": { - "default": { - "summary": "Adding multiple social accounts", - "value": { - "account_urls": [ - "https://facebook.com/GitHub", - "https://www.youtube.com/@GitHub" - ] - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Social account", - "description": "Social media account", - "type": "object", - "properties": { - "provider": { - "type": "string", - "examples": [ - "linkedin" - ] - }, - "url": { - "type": "string", - "examples": [ - "https://www.linkedin.com/company/github/" - ] - } - }, - "required": [ - "provider", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "provider": "twitter", - "url": "https://twitter.com/github" - } - ] - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." }, - "field": { + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", "type": "string" }, - "message": { - "type": "string" + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] }, - "code": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { "type": "string" }, - "index": { + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { "type": "integer" }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] + "watchers": { + "type": "integer" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } + "lexical_commit_sha": { + "type": "string" } - ] + } } - } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "social-accounts" - } - }, - "delete": { - "summary": "Delete social accounts for the authenticated user", - "description": "Deletes one or more social accounts from the authenticated user's profile.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", - "tags": [ - "users" - ], - "operationId": "users/delete-social-account-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user" - }, - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "account_urls": { - "description": "Full URLs for the social media profiles to delete.", - "type": "array", - "items": { - "type": "string", - "examples": [ - "https://twitter.com/github" - ] }, - "examples": [] - } - }, - "required": [ - "account_urls" - ], - "example": { - "account_urls": [ - "https://www.linkedin.com/company/github/", - "https://twitter.com/github" - ] - } - }, - "examples": { - "default": { - "summary": "Deleting multiple social accounts", - "value": { - "account_urls": [ - "https://facebook.com/GitHub", - "https://www.youtube.com/@GitHub" + "required": [ + "starred_at", + "repo" ] } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" + }, + "examples": { + "alternative-response-with-star-creation-timestamps": { + "summary": "Alternative response with star creation timestamps", + "value": [ + { + "starred_at": "2011-01-16T19:06:43Z", + "repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false }, - "code": { - "type": "string" + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true }, - "index": { - "type": "integer" + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } + "forks": 1, + "open_issues": 1, + "watchers": 1 } } - } + ] } } } - } - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } + "type": "string" } } } }, + "304": { + "description": "Not modified" + }, "403": { "description": "Forbidden", "content": { @@ -720947,138 +730776,50 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "social-accounts" + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "starring" } } }, - "/user/ssh_signing_keys": { + "/user/starred/{owner}/{repo}": { "get": { - "summary": "List SSH signing keys for the authenticated user", - "description": "Lists the SSH signing keys for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.", + "summary": "Check if a repository is starred by the authenticated user", + "description": "Whether the authenticated user has starred the repository.", "tags": [ - "users" + "activity" ], - "operationId": "users/list-ssh-signing-keys-for-authenticated-user", + "operationId": "activity/check-repo-is-starred-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user" + "url": "https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user" }, "parameters": [ { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "string" } }, { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "string" } } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "SSH Signing Key", - "description": "A public SSH key used to sign Git commits", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "title": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "key", - "id", - "title", - "created_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 2, - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", - "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", - "created_at": "2020-06-11T21:31:57Z" - }, - { - "id": 3, - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", - "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", - "created_at": "2020-07-11T21:31:57Z" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "304": { - "description": "Not modified" + "204": { + "description": "Response if this repository is starred by you" }, "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", + "description": "Not Found if this repository is not starred by you", "content": { "application/json": { "schema": { @@ -721128,211 +730869,10 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "previews": [], - "category": "users", - "subcategory": "ssh-signing-keys" - } - }, - "post": { - "summary": "Create a SSH signing key for the authenticated user", - "description": "Creates an SSH signing key for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint.", - "operationId": "users/create-ssh-signing-key-for-authenticated-user", - "tags": [ - "users" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user" - }, - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "A descriptive name for the new key.", - "type": "string", - "examples": [ - "Personal MacBook Air" - ] - }, - "key": { - "description": "The public SSH key to add to your GitHub account. For more information, see \"[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).\"", - "type": "string", - "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com " - } - }, - "required": [ - "key" - ], - "type": "object" - }, - "examples": { - "default": { - "value": { - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", - "title": "ssh-rsa AAAAB3NzaC1yc2EAAA" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "SSH Signing Key", - "description": "A public SSH key used to sign Git commits", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "title": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "key", - "id", - "title", - "created_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 2, - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", - "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", - "created_at": "2020-06-11T21:31:57Z" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } }, "304": { "description": "Not modified" }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "403": { "description": "Forbidden", "content": { @@ -721358,111 +730898,52 @@ } } } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "category": "users", - "subcategory": "ssh-signing-keys" + "category": "activity", + "subcategory": "starring" } - } - }, - "/user/ssh_signing_keys/{ssh_signing_key_id}": { - "get": { - "summary": "Get an SSH signing key for the authenticated user", - "description": "Gets extended details for an SSH signing key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.", + }, + "put": { + "summary": "Star a repository for the authenticated user", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ - "users" + "activity" ], - "operationId": "users/get-ssh-signing-key-for-authenticated-user", + "operationId": "activity/star-repo-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user" + "url": "https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user" }, "parameters": [ { - "name": "ssh_signing_key_id", - "description": "The unique identifier of the SSH signing key.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "SSH Signing Key", - "description": "A public SSH key used to sign Git commits", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "title": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "key", - "id", - "title", - "created_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 2, - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", - "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", - "created_at": "2020-06-11T21:31:57Z" - } - } - } - } - } + "204": { + "description": "Response" }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -721487,11 +730968,8 @@ } } }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -721541,34 +731019,46 @@ } } } + }, + "304": { + "description": "Not modified" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "category": "users", - "subcategory": "ssh-signing-keys" + "category": "activity", + "subcategory": "starring" } }, "delete": { - "summary": "Delete an SSH signing key for the authenticated user", - "description": "Deletes an SSH signing key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint.", + "summary": "Unstar a repository for the authenticated user", + "description": "Unstar a repository that the authenticated user has previously starred.", "tags": [ - "users" + "activity" ], - "operationId": "users/delete-ssh-signing-key-for-authenticated-user", + "operationId": "activity/unstar-repo-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user" + "url": "https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user" }, "parameters": [ { - "name": "ssh_signing_key_id", - "description": "The unique identifier of the SSH signing key.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } ], @@ -721576,9 +731066,6 @@ "204": { "description": "Response" }, - "304": { - "description": "Not modified" - }, "404": { "description": "Resource not found", "content": { @@ -721605,8 +731092,8 @@ } } }, - "403": { - "description": "Forbidden", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -721631,8 +731118,11 @@ } } }, - "401": { - "description": "Requires authentication", + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -721661,52 +731151,24 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "category": "users", - "subcategory": "ssh-signing-keys" + "category": "activity", + "subcategory": "starring" } } }, - "/user/starred": { + "/user/subscriptions": { "get": { - "summary": "List repositories starred by the authenticated user", - "description": "Lists repositories the authenticated user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", + "summary": "List repositories watched by the authenticated user", + "description": "Lists repositories the authenticated user is watching.", "tags": [ "activity" ], - "operationId": "activity/list-repos-starred-by-authenticated-user", + "operationId": "activity/list-watched-repos-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user" + "url": "https://docs.github.com/rest/activity/watching#list-repositories-watched-by-the-authenticated-user" }, "parameters": [ - { - "name": "sort", - "description": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", @@ -721734,16 +731196,15 @@ "schema": { "type": "array", "items": { - "title": "Repository", - "description": "A repository on GitHub.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "examples": [ - 42 + 1296269 ] }, "node_id": { @@ -721753,10 +731214,9 @@ ] }, "name": { - "description": "The name of the repository.", "type": "string", "examples": [ - "Team Environment" + "Hello-World" ] }, "full_name": { @@ -721765,96 +731225,6 @@ "octocat/Hello-World" ] }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, "owner": { "title": "Simple User", "description": "A GitHub user.", @@ -722024,8 +731394,6 @@ ] }, "private": { - "description": "Whether the repository is private or public.", - "default": false, "type": "boolean" }, "html_url": { @@ -722162,10 +731530,7 @@ ] }, "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] + "type": "string" }, "issue_comment_url": { "type": "string", @@ -722236,10 +731601,7 @@ ] }, "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] + "type": "string" }, "stargazers_url": { "type": "string", @@ -722289,19 +731651,12 @@ ] }, "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] + "type": "string" }, "mirror_url": { "type": [ "string", "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { @@ -722312,20 +731667,12 @@ ] }, "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] + "type": "string" }, "homepage": { "type": [ "string", "null" - ], - "format": "uri", - "examples": [ - "https://github.com" ] }, "language": { @@ -722335,50 +731682,26 @@ ] }, "forks_count": { - "type": "integer", - "examples": [ - 9 - ] + "type": "integer" }, "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] + "type": "integer" }, "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] + "type": "integer" }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] + "type": "integer" }, "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] + "type": "string" }, "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] + "type": "integer" }, "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "topics": { "type": "array", @@ -722387,47 +731710,22 @@ } }, "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", @@ -722435,23 +731733,15 @@ "enum": [ "all", "collaborators_only" - ], - "examples": [ - "all" ] }, "archived": { - "description": "Whether the repository is archived.", - "default": false, "type": "boolean" }, "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." + "type": "boolean" }, "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", "type": "string" }, "pushed_at": { @@ -722484,127 +731774,304 @@ "2011-01-26T19:14:43Z" ] }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", "examples": [ - true + "admin" ] }, "temp_clone_token": { "type": "string" }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "delete_branch_on_merge": { + "type": "boolean" }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] + "subscribers_count": { + "type": "integer" }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] + "network_count": { + "type": "integer" }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" ] }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" + "license": { + "type": [ + "object", + "null" ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + } + } }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + "forks": { + "type": "integer", + "examples": [ + 0 + ] }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", + "watchers": { + "type": "integer", "examples": [ - true + 0 ] }, "allow_forking": { - "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "starred_at": { - "type": "string", + "type": "boolean", "examples": [ - "\"2020-07-09T00:17:42Z\"" + false ] }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", + "security_and_analysis": { + "type": [ + "object", + "null" + ], "properties": { - "lexical_search_ok": { - "type": "boolean" + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } }, - "lexical_commit_sha": { - "type": "string" + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + }, + "mode": { + "type": "string", + "description": "The bypass mode for the reviewer", + "enum": [ + "ALWAYS", + "EXEMPT" + ], + "default": "ALWAYS" + } + } + } + } + } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -722653,39 +732120,12 @@ "tags_url", "teams_url", "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" + "url" ] } }, "examples": { - "default-response": { - "summary": "Default response", + "default": { "value": [ { "id": 1296269, @@ -722766,7 +732206,7 @@ "size": 108, "default_branch": "master", "open_issues_count": 0, - "is_template": true, + "is_template": false, "topics": [ "octocat", "atom", @@ -722778,6 +732218,7 @@ "has_wiki": true, "has_pages": false, "has_downloads": true, + "has_discussions": false, "archived": false, "disabled": false, "visibility": "public", @@ -722789,191 +732230,251 @@ "push": false, "pull": true }, - "allow_rebase_merge": true, - "template_repository": null, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + }, + "secret_scanning_delegated_alert_dismissal": { + "status": "disabled" + } + } } ] } } - }, - "application/vnd.github.v3.star+json": { + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", "schema": { - "type": "array", - "items": { - "title": "Starred Repository", - "description": "Starred Repository", - "type": "object", - "properties": { - "starred_at": { - "type": "string", - "format": "date-time" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "type": "string" + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "watching" + } + } + }, + "/user/teams": { + "get": { + "summary": "List teams for the authenticated user", + "description": "List all of the teams across all of the organizations to which the authenticated\nuser belongs.\n\nOAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint.\n\nWhen using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.", + "tags": [ + "teams" + ], + "operationId": "teams/list-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#list-teams-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Developers" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "push" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "parent": { + "anyOf": [ + { + "type": "null" }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -722981,935 +732482,632 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/organizations/1/team/1" ] }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "Justice League" ] }, - "following_url": { - "type": "string", + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "A great team." ] }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "admin" ] }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "closed" ] }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "notifications_enabled" ] }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/orgs/rails/teams/core" ] }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "events_url": { + "slug": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "justice-league" ] }, - "received_events_url": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "uid=example,ou=users,dc=github,dc=com" ] }, "type": { + "description": "The ownership type of the team", "type": "string", - "examples": [ - "User" + "enum": [ + "enterprise", + "organization" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 37 ] }, - "user_view_type": { - "type": "string", + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - "public" + 42 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ] - }, - "compare_url": { + } + ] + }, + "members_count": { + "type": "integer", + "examples": [ + 3 + ] + }, + "repos_count": { + "type": "integer", + "examples": [ + 10 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-14T16:53:42Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-08-17T12:37:15Z" + ] + }, + "organization": { + "title": "Team Organization", + "description": "Team Organization", + "type": "object", + "properties": { + "login": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "github" ] }, - "contents_url": { - "type": "string", + "id": { + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + 1 ] }, - "contributors_url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, - "deployments_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "https://api.github.com/orgs/github" ] }, - "downloads_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" + "https://api.github.com/orgs/github/events" ] }, - "git_commits_url": { + "hooks_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "https://api.github.com/orgs/github/hooks" ] }, - "git_refs_url": { + "issues_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "https://api.github.com/orgs/github/issues" ] }, - "git_tags_url": { + "members_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "https://api.github.com/orgs/github/members{/member}" ] }, - "git_url": { + "public_members_url": { "type": "string", "examples": [ - "git:github.com/octocat/Hello-World.git" + "https://api.github.com/orgs/github/public_members{/member}" ] }, - "issue_comment_url": { + "avatar_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "https://github.com/images/error/octocat_happy.gif" ] }, - "issue_events_url": { - "type": "string", + "description": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "A great organization" ] }, - "issues_url": { + "name": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "github" ] }, - "keys_url": { + "company": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "GitHub" ] }, - "labels_url": { + "blog": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "https://github.com/blog" ] }, - "languages_url": { + "location": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + "San Francisco" ] }, - "merges_url": { + "email": { "type": "string", - "format": "uri", + "format": "email", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" + "octocat@github.com" ] }, - "milestones_url": { - "type": "string", + "twitter_username": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "github" ] }, - "notifications_url": { - "type": "string", + "is_verified": { + "type": "boolean", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + true ] }, - "pulls_url": { - "type": "string", + "has_organization_projects": { + "type": "boolean", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + true ] }, - "releases_url": { - "type": "string", + "has_repository_projects": { + "type": "boolean", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + true ] }, - "ssh_url": { - "type": "string", + "public_repos": { + "type": "integer", "examples": [ - "git@github.com:octocat/Hello-World.git" + 2 ] }, - "stargazers_url": { - "type": "string", - "format": "uri", + "public_gists": { + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" + 1 ] }, - "statuses_url": { - "type": "string", + "followers": { + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + 20 ] }, - "subscribers_url": { - "type": "string", - "format": "uri", + "following": { + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + 0 ] }, - "subscription_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + "https://github.com/octocat" ] }, - "tags_url": { + "created_at": { "type": "string", - "format": "uri", + "format": "date-time", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + "2008-01-14T04:33:35Z" ] }, - "teams_url": { + "type": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" + "Organization" ] }, - "trees_url": { - "type": "string", + "total_private_repos": { + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + 100 ] }, - "clone_url": { - "type": "string", + "owned_private_repos": { + "type": "integer", "examples": [ - "https://github.com/octocat/Hello-World.git" + 100 ] }, - "mirror_url": { + "private_gists": { "type": [ - "string", + "integer", "null" ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + 81 ] }, - "svn_url": { - "type": "string", - "format": "uri", + "disk_usage": { + "type": [ + "integer", + "null" + ], "examples": [ - "https://svn.github.com/octocat/Hello-World" + 10000 ] }, - "homepage": { + "collaborators": { "type": [ - "string", + "integer", "null" ], - "format": "uri", "examples": [ - "https://github.com" + 8 ] }, - "language": { + "billing_email": { "type": [ "string", "null" - ] - }, - "forks_count": { - "type": "integer", + ], + "format": "email", "examples": [ - 9 + "org@example.com" ] }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" ] }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 + "default_repository_permission": { + "type": [ + "string", + "null" ] }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], "examples": [ - 108 + true ] }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], "examples": [ - "master" + true ] }, - "open_issues_count": { - "type": "integer", + "members_allowed_repository_creation_type": { + "type": "string", "examples": [ - 0 + "all" ] }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, + "members_can_create_public_repositories": { "type": "boolean", "examples": [ true ] }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, + "members_can_create_private_repositories": { "type": "boolean", "examples": [ true ] }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, + "members_can_create_internal_repositories": { "type": "boolean", "examples": [ true ] }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, + "members_can_create_pages": { "type": "boolean", "examples": [ true ] }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, + "members_can_create_public_pages": { "type": "boolean", "examples": [ true ] }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, + "members_can_create_private_pages": { "type": "boolean", "examples": [ true ] }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ], - "examples": [ - "all" - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { + "members_can_fork_private_repositories": { "type": [ - "string", + "boolean", "null" ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", "examples": [ false ] }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, + "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { + "updated_at": { "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + "format": "date-time" }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" + "archived_at": { + "type": [ + "string", + "null" ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } + "format": "date-time" } }, "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", + "login", + "url", "id", "node_id", - "issue_comment_url", - "issue_events_url", + "repos_url", + "events_url", + "hooks_url", "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", "created_at", - "updated_at" + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "examples": [ + "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 ] } }, "required": [ - "starred_at", - "repo" + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type", + "created_at", + "updated_at", + "members_count", + "repos_count", + "organization" ] } }, "examples": { - "alternative-response-with-star-creation-timestamps": { - "summary": "Alternative response with star creation timestamps", + "default": { "value": [ { - "starred_at": "2011-01-16T19:06:43Z", - "repo": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "template_repository": null, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" } } ] @@ -723929,131 +733127,8 @@ "304": { "description": "Not modified" }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "activity", - "subcategory": "starring" - } - } - }, - "/user/starred/{owner}/{repo}": { - "get": { - "summary": "Check if a repository is starred by the authenticated user", - "description": "Whether the authenticated user has starred the repository.", - "tags": [ - "activity" - ], - "operationId": "activity/check-repo-is-starred-by-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response if this repository is starred by you" - }, "404": { - "description": "Not Found if this repository is not starred by you", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -724078,9 +733153,6 @@ } } }, - "304": { - "description": "Not modified" - }, "403": { "description": "Forbidden", "content": { @@ -724111,169 +733183,716 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "category": "activity", - "subcategory": "starring" + "category": "teams", + "subcategory": "teams" } - }, - "put": { - "summary": "Star a repository for the authenticated user", - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + } + }, + "/user/{account_id}": { + "get": { + "summary": "Get a user using their ID", + "description": "Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).", "tags": [ - "activity" + "users" ], - "operationId": "activity/star-repo-for-authenticated-user", + "operationId": "users/get-by-id", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user" + "url": "https://docs.github.com/rest/users/users#get-a-user-using-their-id" }, "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "name": "account_id", + "description": "account_id parameter", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "user_view_type": { + "type": "string" + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] }, - "status": { - "type": "string" + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "user_view_type": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + ] + }, + "examples": { + "default-response": { + "summary": "Default response", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + }, + "response-with-git-hub-plan-information": { + "summary": "Response with GitHub plan information", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "plan": { + "name": "pro", + "space": 976562499, + "collaborators": 0, + "private_repos": 9999 + } } } } } } }, - "304": { - "description": "Not modified" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "activity", - "subcategory": "starring" - } - }, - "delete": { - "summary": "Unstar a repository for the authenticated user", - "description": "Unstar a repository that the authenticated user has previously starred.", - "tags": [ - "activity" - ], - "operationId": "activity/unstar-repo-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, "404": { "description": "Resource not found", "content": { @@ -724299,4193 +733918,7513 @@ } } } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "activity", - "subcategory": "starring" + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" } } }, - "/user/subscriptions": { - "get": { - "summary": "List repositories watched by the authenticated user", - "description": "Lists repositories the authenticated user is watching.", + "/user/{user_id}/projectsV2/{project_number}/drafts": { + "post": { + "summary": "Create draft item for user owned project", + "description": "Create draft issue item for the specified user owned project.", "tags": [ - "activity" + "projects" ], - "operationId": "activity/list-watched-repos-for-authenticated-user", + "operationId": "projects/create-draft-item-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/activity/watching#list-repositories-watched-by-the-authenticated-user" + "url": "https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project" }, "parameters": [ { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "user_id", + "description": "The unique identifier of the user.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "string" } }, { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "project_number", + "description": "The project's number.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], + "requestBody": { + "required": true, + "description": "Details of the draft item to create in the project.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the draft issue item to create in the project." + }, + "body": { + "type": "string", + "description": "The body content of the draft issue item to create in the project." + } + }, + "required": [ + "title" + ] + }, + "examples": { + "title": { + "summary": "Example with Sample Draft Issue Title", + "value": { + "title": "Sample Draft Issue Title" + } + }, + "body": { + "summary": "Example with Sample Draft Issue Title and Body", + "value": { + "title": "Sample Draft Issue Title", + "body": "This is the body content of the draft issue." + } + } + } + } + } + }, "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project item." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project item." + }, + "content": { + "oneOf": [ + { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } ] - } - } - }, - "secret_scanning_delegated_bypass": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } - } - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "nullable": false + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "nullable": false + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "nullable": false + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "nullable": false + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "nullable": false + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, "required": [ - "reviewer_id", - "reviewer_type" + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", "properties": { - "reviewer_id": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" + "format": "int64", + "examples": [ + 1 + ] }, - "reviewer_type": { + "node_id": { "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" + "examples": [ + "MDQ6VXNlcjE=" ] }, - "mode": { + "avatar_url": { "type": "string", - "description": "The bypass mode for the reviewer", - "enum": [ - "ALWAYS", - "EXEMPT" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" ], - "default": "ALWAYS" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ], + "examples": [ + "all" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" } } } - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - }, - "secret_scanning_delegated_alert_dismissal": { - "status": "disabled" - } - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "activity", - "subcategory": "watching" - } - } - }, - "/user/teams": { - "get": { - "summary": "List teams for the authenticated user", - "description": "List all of the teams across all of the organizations to which the authenticated\nuser belongs.\n\nOAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint.\n\nWhen using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.", - "tags": [ - "teams" - ], - "operationId": "teams/list-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-teams-for-the-authenticated-user" - }, - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "examples": [ - "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "teams", - "subcategory": "teams" - } - } - }, - "/user/{account_id}": { - "get": { - "summary": "Get a user using their ID", - "description": "Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).", - "tags": [ - "users" - ], - "operationId": "users/get-by-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/users/users#get-a-user-using-their-id" - }, - "parameters": [ - { - "name": "account_id", - "description": "account_id parameter", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "title": "Private User", - "description": "Private User", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ], - "examples": [ - "monalisa octocat" - ] - }, - "company": { - "type": [ - "string", - "null" - ], - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": [ - "string", - "null" - ], - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ], - "examples": [ - "There once was..." - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "monalisa" - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "private_gists": { - "type": "integer", - "examples": [ - 81 - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "disk_usage": { - "type": "integer", - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": "integer", - "examples": [ - 8 - ] - }, - "two_factor_authentication": { - "type": "boolean", - "examples": [ - true - ] - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] }, - "name": { - "type": "string" + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, - "space": { - "type": "integer" + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "business_plus": { - "type": "boolean" - }, - "ldap_dn": { - "type": "string" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at", - "collaborators", - "disk_usage", - "owned_private_repos", - "private_gists", - "total_private_repos", - "two_factor_authentication" - ] - }, - { - "title": "Public User", - "description": "Public User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" + "parent_issue_url": { + "description": "URL to get the parent issue of this issue, if it is a sub-issue", + "type": [ + "string", + "null" + ], + "format": "uri" }, - "name": { - "type": "string" + "pinned_comment": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/comments/1" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string", + "examples": [ + "What version of Safari were you using when you observed this bug?" + ] + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "pinned_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "pinned_at", + "pinned_by" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ] + } + ] }, - "space": { - "type": "integer" + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] }, - "private_repos": { - "type": "integer" + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "examples": [ + "Sample text" + ] + }, + { + "type": "number", + "examples": [ + 42.5 + ] + }, + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the option", + "type": "string", + "examples": [ + "High" + ] + }, + "color": { + "description": "The color of the option", + "type": "string", + "examples": [ + "red" + ] + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } } }, "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "private_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "disk_usage": { - "type": "integer", - "examples": [ - 1 + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "created_at", + "updated_at" ] }, - "collaborators": { - "type": "integer", - "examples": [ - 3 - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false - } - ] - }, - "examples": { - "default-response": { - "summary": "Default response", - "value": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z" - } - }, - "response-with-git-hub-plan-information": { - "summary": "Response with GitHub plan information", - "value": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z", - "plan": { - "name": "pro", - "space": 976562499, - "collaborators": 0, - "private_repos": 9999 - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "users" - } - } - }, - "/user/{user_id}/projectsV2/{project_number}/drafts": { - "post": { - "summary": "Create draft item for user owned project", - "description": "Create draft issue item for the specified user owned project.", - "tags": [ - "projects" - ], - "operationId": "projects/create-draft-item-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project" - }, - "parameters": [ - { - "name": "user_id", - "description": "The unique identifier of the user.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_number", - "description": "The project's number.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "description": "Details of the draft item to create in the project.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "The title of the draft issue item to create in the project." - }, - "body": { - "type": "string", - "description": "The body content of the draft issue item to create in the project." - } - }, - "required": [ - "title" - ] - }, - "examples": { - "title": { - "summary": "Example with Sample Draft Issue Title", - "value": { - "title": "Sample Draft Issue Title" - } - }, - "body": { - "summary": "Example with Sample Draft Issue Title and Body", - "value": { - "title": "Sample Draft Issue Title", - "body": "This is the body content of the draft issue." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Projects v2 Item", - "description": "An item belonging to a project", - "type": "object", - "properties": { - "id": { - "type": "number", - "description": "The unique identifier of the project item." - }, - "node_id": { - "type": "string", - "description": "The node ID of the project item." - }, - "content": { - "oneOf": [ { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "title": "Pull Request Simple", + "description": "Pull Request Simple", "type": "object", "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/1347" + ] + }, "id": { "type": "integer", - "format": "int64" + "format": "int64", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" + "type": "string", + "examples": [ + "MDExOlB1bGxSZXF1ZXN0MQ==" + ] }, - "url": { - "description": "URL for the issue", + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repositories/42/issues/1" + "https://github.com/octocat/Hello-World/pull/1347" ] }, - "repository_url": { + "diff_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/pull/1347.diff" + ] }, - "labels_url": { - "type": "string" + "patch_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/pull/1347.patch" + ] }, - "comments_url": { + "issue_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] }, - "events_url": { + "commits_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" + ] }, - "html_url": { + "review_comments_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" + ] + }, + "review_comment_url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] }, "number": { - "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ - 42 + 1347 ] }, "state": { - "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], + "locked": { + "type": "boolean", "examples": [ - "not_planned" + true ] }, "title": { - "description": "Title of the issue", "type": "string", "examples": [ - "Widget creation fails in Safari on OS X 10.8" + "new-feature" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, "body": { - "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ - "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + "Please pull these awesome changes" ] }, - "user": { + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + }, + "milestone": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": "object", "properties": { - "name": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { "type": [ "string", "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "examples": [ + "too heated" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "requested_reviewers": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent", + "type" + ] + } + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "email": { + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { "type": [ "string", "null" + ], + "examples": [ + "This your first repo!" ] }, - "login": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "octocat" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "id": { - "type": "integer", - "format": "int64", + "archive_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "node_id": { + "assignees_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "avatar_url": { + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "deployments_url": { + "type": "string", + "format": "uri", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "html_url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "followers_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "following_url": { + "git_commits_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "gists_url": { + "git_refs_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "starred_url": { + "git_tags_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "subscriptions_url": { + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "organizations_url": { + "merges_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "repos_url": { + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "events_url": { + "statuses_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "received_events_url": { + "subscribers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "type": { + "subscription_url": { "type": "string", + "format": "uri", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "site_admin": { - "type": "boolean" + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] }, - "starred_at": { + "teams_url": { "type": "string", + "format": "uri", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "http://api.github.com/repos/octocat/Hello-World/teams" ] }, - "user_view_type": { + "trees_url": { "type": "string", "examples": [ - "public" + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - }, - "examples": [ - "bug", - "registration" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { + }, + "clone_url": { "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" + "git:git.example.com/octocat/Hello-World" ] }, - "html_url": { + "hooks_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" + "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, - "labels_url": { + "svn_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + "https://svn.github.com/octocat/Hello-World" ] }, - "id": { + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { "type": "integer", "examples": [ - 1002604 + 9 ] }, - "node_id": { + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", "type": "string", "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" + "master" ] }, - "number": { - "description": "The number of the milestone.", + "open_issues_count": { "type": "integer", "examples": [ - 42 + 0 ] }, - "state": { - "description": "The state of the milestone.", + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": [ - "open", - "closed" + "all", + "collaborators_only" ], - "default": "open", "examples": [ - "open" + "all" ] }, - "title": { - "description": "The title of the milestone.", - "type": "string", + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "v1.0" + "2011-01-26T19:06:43Z" ] }, - "description": { + "created_at": { "type": [ "string", "null" ], + "format": "date-time", "examples": [ - "Tracking milestone for version 1.0" + "2011-01-26T19:01:12Z" ] }, - "creator": { + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "label", + "ref", + "repo", + "sha", + "user" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { + "key": { "type": "string", "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 + "mit" ] }, - "node_id": { + "name": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "MIT License" ] }, - "avatar_url": { - "type": "string", + "url": { + "type": [ + "string", + "null" + ], "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "https://api.github.com/licenses/mit" ] }, - "gravatar_id": { + "spdx_id": { "type": [ "string", "null" ], "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MIT" ] }, - "url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "format": "uri" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "key", + "name", + "url", + "spdx_id", + "node_id" ] } ] }, - "open_issues": { - "type": "integer", + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", "examples": [ - 4 + "https://github.com/octocat/Hello-World" ] }, - "closed_issues": { - "type": "integer", + "description": { + "type": [ + "string", + "null" + ], "examples": [ - 8 + "This your first repo!" ] }, - "created_at": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2011-04-10T20:09:31Z" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "updated_at": { + "archive_url": { "type": "string", - "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "closed_at": { + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { "type": [ "string", "null" ], - "format": "date-time", + "format": "uri", "examples": [ - "2013-02-12T13:22:01Z" + "git:git.example.com/octocat/Hello-World" ] }, - "due_on": { + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { "type": [ "string", "null" ], - "format": "date-time", + "format": "uri", "examples": [ - "2012-10-09T23:39:01Z" + "https://github.com" ] - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "nullable": false - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "nullable": false - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "nullable": false - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "nullable": false - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "nullable": false - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { + }, + "language": { "type": [ "string", "null" ] }, - "email": { - "type": [ - "string", - "null" + "forks_count": { + "type": "integer", + "examples": [ + 9 ] }, - "login": { - "type": "string", + "stargazers_count": { + "type": "integer", "examples": [ - "octocat" + 80 ] }, - "id": { + "watchers_count": { "type": "integer", - "format": "int64", "examples": [ - 1 + 80 ] }, - "node_id": { + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "master" ] }, - "avatar_url": { + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", - "format": "uri", + "enum": [ + "all", + "collaborators_only" + ], "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "all" ] }, - "gravatar_id": { + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { "type": [ "string", "null" ], + "format": "date-time", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "2011-01-26T19:06:43Z" ] }, - "url": { - "type": "string", - "format": "uri", + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "https://api.github.com/users/octocat" + "2011-01-26T19:01:12Z" ] }, - "html_url": { - "type": "string", - "format": "uri", + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "https://github.com/octocat" + "2011-01-26T19:14:43Z" ] }, - "followers_url": { - "type": "string", - "format": "uri", + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "https://api.github.com/users/octocat/followers" + true ] }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "temp_clone_token": { + "type": "string" }, - "gists_url": { - "type": "string", + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + true ] }, - "starred_url": { - "type": "string", + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + false ] }, - "subscriptions_url": { - "type": "string", - "format": "uri", + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + false ] }, - "organizations_url": { - "type": "string", - "format": "uri", + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", "examples": [ - "https://api.github.com/users/octocat/orgs" + false ] }, - "repos_url": { + "squash_merge_commit_title": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, - "events_url": { + "squash_merge_commit_message": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, - "received_events_url": { + "merge_commit_title": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, - "type": { + "merge_commit_message": { "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "User" + true ] }, - "site_admin": { + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, "type": "boolean" }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, "starred_at": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "\"2020-07-09T00:17:42Z\"" ] }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } } }, "required": [ - "avatar_url", + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" ] }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "sha": { + "type": "string" }, - "license": { + "user": { "anyOf": [ { "type": "null" }, { - "title": "License Simple", - "description": "License Simple", + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "key": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "mit" + "octocat" ] }, - "name": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", "examples": [ - "MIT License" + "MDQ6VXNlcjE=" ] }, - "url": { - "type": [ - "string", - "null" - ], + "avatar_url": { + "type": "string", "format": "uri", "examples": [ - "https://api.github.com/licenses/mit" + "https://github.com/images/error/octocat_happy.gif" ] }, - "spdx_id": { + "gravatar_id": { "type": [ "string", "null" ], "examples": [ - "MIT" + "41d064eb2195891e12d0413f63227ea7" ] }, - "node_id": { + "url": { "type": "string", + "format": "uri", "examples": [ - "MDc6TGljZW5zZW1pdA==" + "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } ] + } + }, + "required": [ + "label", + "ref", + "repo", + "sha", + "user" + ] + }, + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] }, - "forks": { - "type": "integer" + "commits": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] }, - "permissions": { + "statuses": { + "title": "Link", + "description": "Hypermedia Link", "type": "object", "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" + "href": { + "type": "string" } }, "required": [ - "admin", - "pull", - "push" + "href" ] }, - "owner": { + "html": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "comments", + "commits", + "statuses", + "html", + "issue", + "review_comments", + "review_comment", + "self" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "auto_merge": { + "title": "Auto merge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "enabled_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -728653,3123 +741592,3453 @@ "url" ] }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "merge_method": { "type": "string", + "description": "The merge method to use.", "enum": [ - "all", - "collaborators_only" - ], - "examples": [ - "all" - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false + "merge", + "squash", + "rebase" ] }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { + "commit_title": { "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" + "description": "Title for the merge commit message." }, - "starred_at": { + "commit_message": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } + "description": "Commit message for the merge commit." } }, "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } + "enabled_by", + "merge_method", + "commit_title", + "commit_message" ] }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean", "examples": [ - "OWNER" + false ] + } + }, + "required": [ + "_links", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge" + ] + }, + { + "title": "Draft Issue", + "description": "A draft issue in a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The ID of the draft issue" }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] + "node_id": { + "type": "string", + "description": "The node ID of the draft issue" }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] + "title": { + "type": "string", + "description": "The title of the draft issue" }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", + "body": { "type": [ "string", "null" ], - "format": "uri" + "description": "The body content of the draft issue" }, - "pinned_comment": { + "user": { "anyOf": [ { "type": "null" }, { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the issue comment", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/comments/1" - ] - }, - "body": { - "description": "Contents of the issue comment", - "type": "string", - "examples": [ - "What version of Safari were you using when you observed this bug?" - ] - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "name": { + "type": [ + "string", + "null" ] }, - "created_at": { + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", - "format": "date-time", "examples": [ - "2011-04-14T16:00:49Z" + "octocat" ] }, - "updated_at": { - "type": "string", - "format": "date-time", + "id": { + "type": "integer", + "format": "int64", "examples": [ - "2011-04-14T16:00:49Z" + 1 ] }, - "issue_url": { + "node_id": { "type": "string", - "format": "uri" + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "author_association": { - "title": "author_association", + "avatar_url": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" ], "examples": [ - "OWNER" + "41d064eb2195891e12d0413f63227ea7" ] }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" ] }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" ] }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } ] }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time the draft issue was created" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time the draft issue was last updated" + } + }, + "required": [ + "id", + "node_id", + "title", + "user", + "created_at", + "updated_at" + ] + } + ], + "description": "The content represented by the item." + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the item was archived.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "description": "The URL of the project this item belongs to." + }, + "item_url": { + "type": "string", + "format": "uri", + "description": "The URL of the item in the project." + } + }, + "required": [ + "id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "examples": { + "draft_issue": { + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "drafts" + } + } + }, + "/users": { + "get": { + "summary": "List users", + "description": "Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.", + "tags": [ + "users" + ], + "operationId": "users/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/users#list-users" + }, + "parameters": [ + { + "name": "since", + "description": "A user ID. Only return users with an ID greater than this ID.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "description": "Not modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" + } + } + }, + "/users/{user_id}/projectsV2/{project_number}/views": { + "post": { + "summary": "Create a view for a user-owned project", + "description": "Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered.", + "tags": [ + "projects" + ], + "operationId": "projects/create-view-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project" + }, + "parameters": [ + { + "name": "user_id", + "description": "The unique identifier of the user.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_number", + "description": "The project's number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the view.", + "examples": [ + "Sprint Board" + ] + }, + "layout": { + "type": "string", + "description": "The layout of the view.", + "enum": [ + "table", + "board", + "roadmap" + ], + "examples": [ + "board" + ] + }, + "filter": { + "type": "string", + "description": "The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", + "examples": [ + "is:issue is:open" + ] + }, + "visible_fields": { + "type": "array", + "description": "`visible_fields` is not applicable to `roadmap` layout views.\nFor `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used.", + "items": { + "type": "integer" + }, + "examples": [ + 123, + 456, + 789 + ] + } + }, + "required": [ + "name", + "layout" + ], + "additionalProperties": false + }, + "examples": { + "table_view": { + "summary": "Create a table view", + "value": { + "name": "All Issues", + "layout": "table", + "filter": "is:issue", + "visible_fields": [ + 123, + 456, + 789 + ] + } + }, + "board_view": { + "summary": "Create a board view with filter", + "value": { + "name": "Sprint Board", + "layout": "board", + "filter": "is:issue is:open label:sprint", + "visible_fields": [ + 123, + 456, + 789 + ] + } + }, + "roadmap_view": { + "summary": "Create a roadmap view", + "value": { + "name": "Product Roadmap", + "layout": "roadmap" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response for creating a view in a user-owned project.", + "content": { + "application/json": { + "schema": { + "title": "Projects v2 View", + "description": "A view inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the view." + }, + "number": { + "type": "integer", + "description": "The number of the view within the project." + }, + "name": { + "type": "string", + "description": "The name of the view." + }, + "layout": { + "type": "string", + "description": "The layout of the view.", + "enum": [ + "table", + "board", + "roadmap" + ] + }, + "node_id": { + "type": "string", + "description": "The node ID of the view." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the view.", + "examples": [ + "https://api.github.com/orgs/octocat/projectsV2/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The web URL of the view.", + "examples": [ + "https://github.com/orgs/octocat/projects/1/views/1" + ] + }, + "creator": { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the view was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the view was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "filter": { + "type": [ + "string", + "null" + ], + "description": "The filter query for the view.", + "examples": [ + "is:issue is:open" + ] + }, + "visible_fields": { + "type": "array", + "description": "The list of field IDs that are visible in the view.", + "items": { + "type": "integer" + } + }, + "sort_by": { + "type": "array", + "description": "The sorting configuration for the view. Each element is a tuple of [field_id, direction] where direction is \"asc\" or \"desc\".", + "items": { + "type": "array", + "minItems": 2, + "maxItems": 2, + "items": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + }, + "group_by": { + "type": "array", + "description": "The list of field IDs used for horizontal grouping.", + "items": { + "type": "integer" + } + }, + "vertical_group_by": { + "type": "array", + "description": "The list of field IDs used for vertical grouping (board layout).", + "items": { + "type": "integer" + } + } + }, + "required": [ + "id", + "number", + "name", + "layout", + "node_id", + "project_url", + "html_url", + "creator", + "created_at", + "updated_at", + "visible_fields", + "sort_by", + "group_by", + "vertical_group_by" + ] + }, + "examples": { + "table_view": { + "summary": "Response for creating a table view", + "value": { + "value": { + "id": 1, + "number": 1, + "name": "Sprint Board", + "layout": "board", + "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", + "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", + "html_url": "https://github.com/orgs/octocat/projects/1/views/1", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "filter": "is:issue is:open", + "visible_fields": [ + 123, + 456, + 789 + ], + "sort_by": [ + [ + 123, + "asc" + ], + [ + 456, + "desc" + ] + ], + "group_by": [ + 123 + ], + "vertical_group_by": [ + 456 + ] + } + } + }, + "board_view": { + "summary": "Response for creating a board view with filter", + "value": { + "value": { + "id": 1, + "number": 1, + "name": "Sprint Board", + "layout": "board", + "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", + "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", + "html_url": "https://github.com/orgs/octocat/projects/1/views/1", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "filter": "is:issue is:open", + "visible_fields": [ + 123, + 456, + 789 + ], + "sort_by": [ + [ + 123, + "asc" + ], + [ + 456, + "desc" + ] + ], + "group_by": [ + 123 + ], + "vertical_group_by": [ + 456 + ] + } + } + }, + "roadmap_view": { + "summary": "Response for creating a roadmap view", + "value": { + "value": { + "id": 1, + "number": 1, + "name": "Sprint Board", + "layout": "board", + "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", + "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", + "html_url": "https://github.com/orgs/octocat/projects/1/views/1", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "filter": "is:issue is:open", + "visible_fields": [ + 123, + 456, + 789 + ], + "sort_by": [ + [ + 123, + "asc" + ], + [ + 456, + "desc" + ] + ], + "group_by": [ + 123 + ], + "vertical_group_by": [ + 456 + ] + } + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] - }, - { - "type": "number", - "examples": [ - 42.5 - ] - }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] - }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" + { + "type": [ + "integer", + "null" ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } } - } - }, - "required": [ - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "created_at", - "updated_at" + ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "projects", + "subcategory": "views" + } + } + }, + "/users/{username}": { + "get": { + "summary": "Get a user", + "description": "Provides publicly available information about someone with a GitHub account.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).", + "tags": [ + "users" + ], + "operationId": "users/get-by-username", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/users#get-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "octocat" ] }, - { - "title": "Pull Request Simple", - "description": "Pull Request Simple", + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "user_view_type": { + "type": "string" + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/1347" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOlB1bGxSZXF1ZXN0MQ==" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/pull/1347" - ] - }, - "diff_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/pull/1347.diff" - ] - }, - "patch_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/pull/1347.patch" - ] - }, - "issue_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - }, - "commits_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" - ] - }, - "review_comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" - ] - }, - "review_comment_url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" - ] + "collaborators": { + "type": "integer" }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" - ] + "name": { + "type": "string" }, - "statuses_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] + "space": { + "type": "integer" }, - "number": { - "type": "integer", - "examples": [ - 1347 - ] + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "user_view_type": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" }, - "state": { - "type": "string", - "examples": [ - "open" - ] + "name": { + "type": "string" }, - "locked": { - "type": "boolean", - "examples": [ - true - ] + "space": { + "type": "integer" }, - "title": { - "type": "string", - "examples": [ - "new-feature" - ] + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + } + ] + }, + "examples": { + "default-response": { + "summary": "Default response", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "response-with-git-hub-plan-information": { + "summary": "Response with GitHub plan information", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "plan": { + "name": "pro", + "space": 976562499, + "collaborators": 0, + "private_repos": 9999 + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" + } + } + }, + "/users/{username}/attestations/bulk-list": { + "post": { + "summary": "List attestations by bulk subject digests", + "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "users" + ], + "operationId": "users/list-attestations-bulk", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "subject_digests": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of subject digests to fetch attestations for.", + "minItems": 1, + "maxItems": 1024 + }, + "predicate_type": { + "type": "string", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types." + } + }, + "required": [ + "subject_digests" + ] + }, + "examples": { + "default": { + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ] + } + }, + "withPredicateType": { + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ], + "predicateType": "provenance" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations_subject_digests": { + "type": "object", + "additionalProperties": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "repository_id": { + "type": "integer" }, - "user": { - "anyOf": [ - { - "type": "null" + "bundle_url": { + "type": "string" + } + } + } + }, + "description": "Mapping of subject digest to bundles." + }, + "page_info": { + "type": "object", + "properties": { + "has_next": { + "type": "boolean", + "description": "Indicates whether there is a next page." + }, + "has_previous": { + "type": "boolean", + "description": "Indicates whether there is a previous page." + }, + "next": { + "type": "string", + "description": "The cursor to the next page." + }, + "previous": { + "type": "string", + "description": "The cursor to the previous page." + } + }, + "description": "Information about the current page." + } + } + }, + "examples": { + "default": { + "value": { + "attestations_subject_digests": [ + { + "sha256:abc": [ + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" ] } - ] - }, - "body": { - "type": [ - "string", - "null" - ], - "examples": [ - "Please pull these awesome changes" - ] + }, + "repository_id": 1 }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + } + ] + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + } + } + }, + "/users/{username}/attestations/delete-request": { + "post": { + "summary": "Delete attestations in bulk", + "description": "Delete artifact attestations in bulk by either subject digests or unique ID.", + "tags": [ + "users" + ], + "operationId": "users/delete-attestations-bulk", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "oneOf": [ + { + "properties": { + "subject_digests": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of subject digests associated with the artifact attestations to delete.", + "minItems": 1, + "maxItems": 1024 + } + }, + "required": [ + "subject_digests" + ] + }, + { + "properties": { + "attestation_ids": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of unique IDs associated with the artifact attestations to delete.", + "minItems": 1, + "maxItems": 1024 + } + }, + "required": [ + "attestation_ids" + ] + } + ], + "description": "The request body must include either `subject_digests` or `attestation_ids`, but not both." + }, + "examples": { + "by-subject-digests": { + "summary": "Delete by subject digests", + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ] + } + }, + "by-attestation-ids": { + "summary": "Delete by attestation IDs", + "value": { + "attestation_ids": [ + 111, + 222 + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + } + } + }, + "/users/{username}/attestations/digest/{subject_digest}": { + "delete": { + "summary": "Delete attestations by subject digest", + "description": "Delete an artifact attestation by subject digest.", + "tags": [ + "users" + ], + "operationId": "users/delete-attestations-by-subject-digest", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "subject_digest", + "description": "Subject Digest", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "responses": { + "200": { + "description": "Response" + }, + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + } + } + }, + "/users/{username}/attestations/{attestation_id}": { + "delete": { + "summary": "Delete attestations by ID", + "description": "Delete an artifact attestation by unique ID that is associated with a repository owned by a user.", + "tags": [ + "users" + ], + "operationId": "users/delete-attestations-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/attestations#delete-attestations-by-id" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "attestation_id", + "description": "Attestation ID", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response" + }, + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + } + } + }, + "/users/{username}/attestations/{subject_digest}": { + "get": { + "summary": "List attestations", + "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "users" + ], + "operationId": "users/list-attestations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/attestations#list-attestations" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "subject_digest", + "description": "Subject Digest", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + }, + "initiator": { + "type": "string" + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "attestations": [ + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" }, - "description": { - "type": "string" + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" }, - "color": { - "type": "string" + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" } }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ] + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "examples": [ - "too heated" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + } + }, + "repository_id": 1 + }, + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" }, - "gravatar_id": { - "type": [ - "string", - "null" + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" } }, - "requested_reviewers": { - "type": "array", - "items": { + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + } + ] + } + } + } + } + } + }, + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + } + } + }, + "/users/{username}/copilot-spaces": { + "get": { + "summary": "List Copilot Spaces for a user", + "description": "Lists Copilot Spaces owned by a user. The authenticated user must have read access to the user's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes the user's own spaces, and public user spaces when accessing another user's spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-copilot-spaces-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "spaces" + ], + "properties": { + "spaces": { + "type": "array", + "description": "The list of Copilot Spaces on this page of results.", + "items": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { + "anyOf": [ + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -731936,3166 +745205,2896 @@ "type", "url" ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", "type": "object", "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", + "login": { "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } + "github" ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ], - "examples": [ - "all" - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "sha": { - "type": "string" + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - } + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "base": { + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { "type": "object", "properties": { - "label": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." }, - "ref": { - "type": "string" + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { "type": "object", + "description": "Metadata specific to the resource type.", "properties": { - "id": { - "description": "Unique identifier of the repository", + "repository_id": { "type": "integer", - "format": "int64", - "examples": [ - 42 - ] + "description": "Repository ID for repository or file resources." }, - "node_id": { + "file_path": { "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "description": "File path for file resources." }, - "name": { - "description": "The name of the repository.", + "text": { "type": "string", - "examples": [ - "Team Environment" - ] + "description": "Text content for free text resources." }, - "full_name": { + "name": { "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "description": "Name for the resource." }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "number": { + "type": "integer", + "description": "Issue or PR number." }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." }, - "html_url": { + "media_type": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" + "description": "Media type for media content resources." }, "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] + "description": "URL for media content resources." }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "height": { "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] + "description": "Height for media content resources." }, - "open_issues_count": { + "width": { "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ], - "examples": [ - "all" - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } + "description": "Width for media content resources." } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "sha": { + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + }, + "examples": { + "default": { + "summary": "Example response for listing user copilot spaces", + "value": { + "spaces": [ + { + "id": 42, + "number": 1, + "name": "Personal Research Space", + "description": "My personal space for research and development", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/1", + "api_url": "https://api.github.com/user/1/copilot-spaces/1" + }, + { + "id": 43, + "number": 2, + "name": "Learning Space", + "description": "Space for learning new technologies", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-17T08:20:00Z", + "updated_at": "2023-02-17T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/2", + "api_url": "https://api.github.com/user/1/copilot-spaces/2" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "post": { + "summary": "Create a Copilot Space for a user", + "description": "Creates a new Copilot Space owned by a user. Only the authenticated user can create spaces for their own account.\n\nUsers can create personal Copilot Spaces for their individual use.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/create-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Personal space for development assistance" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help me with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "no_access" + ], + "description": "The base role that determines default permissions for the space.\n- `no_access`: No default access (default)\n- `reader`: Makes the space publicly readable\nNote: User spaces do not support writer or admin base roles.", + "default": "no_access" + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "My Development Space", + "description": "Personal space for development assistance", + "general_instructions": "Help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/App.js" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Development Notes", + "text": "Focus on clean code principles and modern React patterns" + } + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + }, + "examples": { + "default": { + "summary": "Example response for a user copilot space", + "value": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}": { + "get": { + "summary": "Get a Copilot Space for a user", + "description": "Gets details about a specific Copilot Space owned by a user. The authenticated user must have read access to the Space.\n\nPrivate user spaces require the authenticated user to be the owner of the space.\nPublic user spaces are accessible to any authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/get-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" + "email": { + "type": [ + "string", + "null" ] }, - "author_association": { - "title": "author_association", + "login": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" ], "examples": [ - "OWNER" + "41d064eb2195891e12d0413f63227ea7" ] }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { "type": [ - "object", + "string", "null" ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + }, + "examples": { + "default": { + "summary": "Example response for a user copilot space", + "value": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "put": { + "summary": "Set a Copilot Space for a user", + "description": "Updates a Copilot Space owned by a user. Only the authenticated user can update spaces for their own account.\n\nUsers can update their personal Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "Updated Development Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Updated personal space for development assistance" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Updated instructions to help me with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "no_access" + ], + "description": "The base role that determines default permissions for the space. Changing this field requires admin permissions.\n- `no_access`: No default access (default)\n- `reader`: Makes the space publicly readable\nNote: User spaces do not support writer or admin base roles." + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "Updated Development Space", + "description": "Updated personal space for development assistance", + "general_instructions": "Updated instructions to help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/UpdatedApp.js" + } + }, + { + "id": 123, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Development Notes", + "text": "Updated focus on clean code principles and modern React patterns" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean", + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", "examples": [ - false + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ - "_links", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", "html_url", "id", "node_id", - "issue_url", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, { - "title": "Draft Issue", - "description": "A draft issue in a project", + "title": "Organization Simple", + "description": "A GitHub organization.", "type": "object", "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, "id": { - "type": "number", - "description": "The ID of the draft issue" + "type": "integer", + "examples": [ + 1 + ] }, "node_id": { "type": "string", - "description": "The node ID of the draft issue" + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] }, - "title": { + "url": { "type": "string", - "description": "The title of the draft issue" + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "body": { + "description": { "type": [ "string", "null" ], - "description": "The body content of the draft issue" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "examples": [ + "A great organization" ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The time the draft issue was created" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The time the draft issue was last updated" } }, "required": [ + "login", + "url", "id", "node_id", - "title", - "user", - "created_at", - "updated_at" + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" ] } ], - "description": "The content represented by the item." - }, - "content_type": { - "title": "Projects v2 Item Content Type", - "description": "The type of content tracked in a project item", - "type": "string", - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] + "description": "The user or organization that owns this space." }, "creator": { "title": "Simple User", @@ -735268,83 +748267,170 @@ "created_at": { "type": "string", "format": "date-time", - "description": "The time when the item was created.", + "description": "The date and time the space was created.", "examples": [ - "2022-04-28T12:00:00Z" + "2023-01-01T00:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", - "description": "The time when the item was last updated.", + "description": "The date and time the space was last updated.", "examples": [ - "2022-04-28T12:00:00Z" + "2023-01-01T12:00:00Z" ] }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time when the item was archived.", + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", "examples": [ - "2022-04-28T12:00:00Z" + "https://github.com/copilot/spaces/octo-org/5" ] }, - "project_url": { + "api_url": { "type": "string", "format": "uri", - "description": "The URL of the project this item belongs to." + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] }, - "item_url": { - "type": "string", - "format": "uri", - "description": "The URL of the item in the project." + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } } }, "required": [ "id", - "content_type", + "number", + "name", + "base_role", + "owner", + "creator", "created_at", "updated_at", - "archived_at" - ] + "html_url", + "api_url" + ], + "additionalProperties": false }, "examples": { - "draft_issue": { + "default": { + "summary": "Example response for a user copilot space", "value": { - "id": 17, - "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", - "content": { - "id": 38, - "node_id": "I_kwDOANN5s85FtLts", - "title": "Example Draft Issue", - "body": "This is a draft issue in the project.", - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false }, - "content_type": "DraftIssue", "creator": { "login": "octocat", "id": 1, @@ -735365,20 +748451,35 @@ "type": "User", "site_admin": false }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "archived_at": null, - "project_url": "https://api.github.com/users/octocat/projectsV2/1", - "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] } } } } } }, - "304": { - "description": "Not modified" - }, "403": { "description": "Forbidden", "content": { @@ -735405,8 +748506,8 @@ } } }, - "401": { - "description": "Requires authentication", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -735430,45 +748531,262 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects", - "subcategory": "drafts" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "delete": { + "summary": "Delete a Copilot Space for a user", + "description": "Deletes a Copilot Space owned by a user. The authenticated user must be the owner of the space.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a space will remove all associated resources and configurations.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/delete-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "The Copilot Space has been successfully deleted." + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } } }, - "/users": { + "/users/{username}/copilot-spaces/{space_number}/collaborators": { "get": { - "summary": "List users", - "description": "Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.", + "summary": "List collaborators for a Copilot Space for a user", + "description": "Lists all collaborators for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nEach collaborator entry specifies which user has access to the space and at what level (reader, writer, or admin). The space owner is excluded from this list.\n\nTeam collaborators are not supported for user-owned Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/list", + "operationId": "copilot-spaces/list-collaborators-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/users/users#list-users" + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-a-copilot-space-for-a-user" }, "parameters": [ { - "name": "since", - "description": "A user ID. Only return users with an ID greater than this ID.", - "in": "query", - "required": false, + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "integer" } } ], @@ -735478,241 +748796,463 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" + "type": "object", + "required": [ + "collaborators" + ], + "properties": { + "collaborators": { + "type": "array", + "description": "The list of collaborators for this Copilot Space.", + "items": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } ] } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + } } }, "examples": { "default": { - "value": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ] + "value": { + "collaborators": [ + { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "User", + "role": "reader", + "login": "github-user", + "id": 67890, + "node_id": "MDQ6VXNlcjY3ODkw", + "avatar_url": "https://github.com/images/error/other_user.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github-user", + "html_url": "https://github.com/github-user", + "followers_url": "https://api.github.com/users/github-user/followers", + "following_url": "https://api.github.com/users/github-user/following{/other_user}", + "gists_url": "https://api.github.com/users/github-user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github-user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github-user/subscriptions", + "organizations_url": "https://api.github.com/users/github-user/orgs", + "repos_url": "https://api.github.com/users/github-user/repos", + "events_url": "https://api.github.com/users/github-user/events{/privacy}", + "received_events_url": "https://api.github.com/users/github-user/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "GitHub User", + "company": null, + "blog": "", + "location": null, + "email": null, + "hireable": null, + "bio": null, + "twitter_username": null, + "public_repos": 5, + "public_gists": 0, + "followers": 10, + "following": 5, + "created_at": "2010-01-14T04:33:35Z", + "updated_at": "2010-01-14T04:33:35Z" + } + ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\"", + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } } } } }, - "304": { - "description": "Not modified" + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "users" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" } - } - }, - "/users/{user_id}/projectsV2/{project_number}/views": { + }, "post": { - "summary": "Create a view for a user-owned project", - "description": "Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered.", + "summary": "Add a collaborator to a Copilot Space for a user", + "description": "Adds a collaborator to a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nTeam collaborators are not supported for user-owned Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", "tags": [ - "projects" + "copilot-spaces" ], - "operationId": "projects/create-view-for-user", + "operationId": "copilot-spaces/add-collaborator-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project" + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-a-copilot-space-for-a-user" }, "parameters": [ { - "name": "user_id", - "description": "The unique identifier of the user.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { @@ -735720,8 +749260,8 @@ } }, { - "name": "project_number", - "description": "The project's number.", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { @@ -735735,84 +749275,41 @@ "application/json": { "schema": { "type": "object", + "required": [ + "actor_type", + "actor_identifier", + "role" + ], "properties": { - "name": { - "type": "string", - "description": "The name of the view.", - "examples": [ - "Sprint Board" - ] - }, - "layout": { + "actor_type": { "type": "string", - "description": "The layout of the view.", "enum": [ - "table", - "board", - "roadmap" + "User", + "Team" ], - "examples": [ - "board" - ] + "description": "The type of actor (must be `User` for user-owned spaces; `Team` will be rejected)." }, - "filter": { + "actor_identifier": { "type": "string", - "description": "The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", - "examples": [ - "is:issue is:open" - ] + "description": "The username of the collaborator. The numeric user ID is also accepted." }, - "visible_fields": { - "type": "array", - "description": "`visible_fields` is not applicable to `roadmap` layout views.\nFor `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used.", - "items": { - "type": "integer" - }, - "examples": [ - 123, - 456, - 789 - ] + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role to grant to the collaborator." } - }, - "required": [ - "name", - "layout" - ], - "additionalProperties": false + } }, "examples": { - "table_view": { - "summary": "Create a table view", - "value": { - "name": "All Issues", - "layout": "table", - "filter": "is:issue", - "visible_fields": [ - 123, - 456, - 789 - ] - } - }, - "board_view": { - "summary": "Create a board view with filter", - "value": { - "name": "Sprint Board", - "layout": "board", - "filter": "is:issue is:open label:sprint", - "visible_fields": [ - 123, - 456, - 789 - ] - } - }, - "roadmap_view": { - "summary": "Create a roadmap view", + "default": { "value": { - "name": "Product Roadmap", - "layout": "roadmap" + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" } } } @@ -735821,55 +749318,15 @@ }, "responses": { "201": { - "description": "Response for creating a view in a user-owned project.", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Projects v2 View", - "description": "A view inside a projects v2 project", + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the view." - }, - "number": { - "type": "integer", - "description": "The number of the view within the project." - }, - "name": { - "type": "string", - "description": "The name of the view." - }, - "layout": { - "type": "string", - "description": "The layout of the view.", - "enum": [ - "table", - "board", - "roadmap" - ] - }, - "node_id": { - "type": "string", - "description": "The node ID of the view." - }, - "project_url": { - "type": "string", - "description": "The API URL of the project that contains the view.", - "examples": [ - "https://api.github.com/orgs/octocat/projectsV2/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The web URL of the view.", - "examples": [ - "https://github.com/orgs/octocat/projects/1/views/1" - ] - }, - "creator": { + "anyOf": [ + { "allOf": [ { "title": "Simple User", @@ -736038,274 +749495,722 @@ "type", "url" ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] } ] }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The time when the view was created.", - "examples": [ - "2022-04-28T12:00:00Z" + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" ] + } + ] + }, + "examples": { + "default": { + "value": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The time when the view was last updated.", - "examples": [ - "2022-04-28T12:00:00Z" - ] + "documentation_url": { + "type": "string" }, - "filter": { - "type": [ - "string", - "null" - ], - "description": "The filter query for the view.", - "examples": [ - "is:issue is:open" - ] + "url": { + "type": "string" }, - "visible_fields": { - "type": "array", - "description": "The list of field IDs that are visible in the view.", - "items": { - "type": "integer" - } + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "sort_by": { + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", - "description": "The sorting configuration for the view. Each element is a tuple of [field_id, direction] where direction is \"asc\" or \"desc\".", "items": { - "type": "array", - "minItems": 2, - "maxItems": 2, - "items": { - "oneOf": [ - { - "type": "integer" + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { + "put": { + "summary": "Set a collaborator role for a Copilot Space for a user", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-collaborator-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "The type of actor (must be `User` for user-owned spaces; `Team` will be rejected).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username of the collaborator. The numeric user ID is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "role" + ], + "properties": { + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The new role to grant to the collaborator. Use `no_access` to remove the collaborator." + } + } + }, + "examples": { + "default": { + "value": { + "role": "admin" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - { - "type": "string" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" } + }, + "required": [ + "actor_type", + "role" ] } - } - }, - "group_by": { - "type": "array", - "description": "The list of field IDs used for horizontal grouping.", - "items": { - "type": "integer" - } + ] }, - "vertical_group_by": { - "type": "array", - "description": "The list of field IDs used for vertical grouping (board layout).", - "items": { - "type": "integer" - } - } - }, - "required": [ - "id", - "number", - "name", - "layout", - "node_id", - "project_url", - "html_url", - "creator", - "created_at", - "updated_at", - "visible_fields", - "sort_by", - "group_by", - "vertical_group_by" - ] - }, - "examples": { - "table_view": { - "summary": "Response for creating a table view", - "value": { - "value": { - "id": 1, - "number": 1, - "name": "Sprint Board", - "layout": "board", - "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", - "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", - "html_url": "https://github.com/orgs/octocat/projects/1/views/1", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "filter": "is:issue is:open", - "visible_fields": [ - 123, - 456, - 789 - ], - "sort_by": [ - [ - 123, - "asc" + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" ], - [ - 456, - "desc" + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" ] - ], - "group_by": [ - 123 - ], - "vertical_group_by": [ - 456 - ] - } - } - }, - "board_view": { - "summary": "Response for creating a board view with filter", - "value": { - "value": { - "id": 1, - "number": 1, - "name": "Sprint Board", - "layout": "board", - "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", - "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", - "html_url": "https://github.com/orgs/octocat/projects/1/views/1", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "filter": "is:issue is:open", - "visible_fields": [ - 123, - 456, - 789 - ], - "sort_by": [ - [ - 123, - "asc" - ], - [ - 456, - "desc" + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" ] - ], - "group_by": [ - 123 - ], - "vertical_group_by": [ - 456 - ] - } + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] } - }, - "roadmap_view": { - "summary": "Response for creating a roadmap view", + ] + }, + "examples": { + "default": { "value": { - "value": { - "id": 1, - "number": 1, - "name": "Sprint Board", - "layout": "board", - "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", - "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", - "html_url": "https://github.com/orgs/octocat/projects/1/views/1", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "filter": "is:issue is:open", - "visible_fields": [ - 123, - 456, - 789 - ], - "sort_by": [ - [ - 123, - "asc" - ], - [ - 456, - "desc" - ] - ], - "group_by": [ - 123 - ], - "vertical_group_by": [ - 456 - ] - } + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" } } } } } }, - "304": { - "description": "Not modified" + "204": { + "description": "Response when `role` is `no_access` and the collaborator was removed." }, "403": { "description": "Forbidden", @@ -736333,32 +750238,6 @@ } } }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "404": { "description": "Resource not found", "content": { @@ -736459,9 +750338,99 @@ } } } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + }, + "delete": { + "summary": "Remove a collaborator from a Copilot Space for a user", + "description": "Removes a collaborator from a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/remove-collaborator-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "503": { - "description": "Service unavailable", + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "The type of actor (must be `User` for user-owned spaces; `Team` will be rejected).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username of the collaborator. The numeric user ID is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -736488,24 +750457,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": false, - "category": "projects", - "subcategory": "views" + "category": "copilot-spaces", + "subcategory": "collaborators" } } }, - "/users/{username}": { + "/users/{username}/copilot-spaces/{space_number}/resources": { "get": { - "summary": "Get a user", - "description": "Provides publicly available information about someone with a GitHub account.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).", + "summary": "List resources for a Copilot Space for a user", + "description": "Lists all resources attached to a specific Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/get-by-username", + "operationId": "copilot-spaces/list-resources-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/users/users#get-a-user" + "url": "https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-a-copilot-space-for-a-user" }, "parameters": [ { @@ -736516,6 +750484,15 @@ "schema": { "type": "string" } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { @@ -736524,676 +750501,112 @@ "content": { "application/json": { "schema": { - "oneOf": [ - { - "title": "Private User", - "description": "Private User", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ], - "examples": [ - "monalisa octocat" - ] - }, - "company": { - "type": [ - "string", - "null" - ], - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": [ - "string", - "null" - ], - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ], - "examples": [ - "There once was..." - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "monalisa" - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "private_gists": { - "type": "integer", - "examples": [ - 81 - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "disk_usage": { - "type": "integer", - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": "integer", - "examples": [ - 8 - ] - }, - "two_factor_authentication": { - "type": "boolean", - "examples": [ - true - ] - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } + "type": "object", + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "business_plus": { - "type": "boolean" - }, - "ldap_dn": { - "type": "string" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at", - "collaborators", - "disk_usage", - "owned_private_repos", - "private_gists", - "total_private_repos", - "two_factor_authentication" - ] - }, - { - "title": "Public User", - "description": "Public User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "private_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "disk_usage": { - "type": "integer", - "examples": [ - 1 - ] + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } }, - "collaborators": { - "type": "integer", - "examples": [ - 3 - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } } - ] + } }, "examples": { - "default-response": { - "summary": "Default response", + "default": { "value": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z" + "resources": [ + { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + ] } - }, - "response-with-git-hub-plan-information": { - "summary": "Response with GitHub plan information", - "value": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z", - "plan": { - "name": "pro", - "space": 976562499, - "collaborators": 0, - "private_repos": 9999 - } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -737228,60 +750641,39 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "users" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/users/{username}/attestations/bulk-list": { + }, "post": { - "summary": "List attestations by bulk subject digests", - "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "summary": "Create a resource for a Copilot Space for a user", + "description": "Creates a new resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/list-attestations-bulk", + "operationId": "copilot-spaces/create-resource-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests" + "url": "https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-a-copilot-space-for-a-user" }, "parameters": [ { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, "schema": { "type": "string" } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -737291,41 +750683,55 @@ "application/json": { "schema": { "type": "object", + "required": [ + "resource_type", + "metadata" + ], "properties": { - "subject_digests": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of subject digests to fetch attestations for.", - "minItems": 1, - "maxItems": 1024 - }, - "predicate_type": { + "resource_type": { "type": "string", - "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types." + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ], + "description": "The type of resource to create." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata.", + "additionalProperties": true } - }, - "required": [ - "subject_digests" - ] + } }, "examples": { - "default": { + "free_text": { "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" - ] + "resource_type": "free_text", + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + } } }, - "withPredicateType": { + "repository": { "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" - ], - "predicateType": "provenance" + "resource_type": "repository", + "metadata": { + "repository_id": 42 + } + } + }, + "github_file": { + "value": { + "resource_type": "github_file", + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + } } } } @@ -737333,295 +750739,182 @@ } }, "responses": { - "200": { - "description": "Response", + "201": { + "description": "Resource created", "content": { "application/json": { "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", "type": "object", "properties": { - "attestations_subject_digests": { - "type": "object", - "additionalProperties": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "repository_id": { - "type": "integer" - }, - "bundle_url": { - "type": "string" - } - } - } - }, - "description": "Mapping of subject digest to bundles." + "id": { + "type": "integer", + "description": "The unique identifier of the resource." }, - "page_info": { + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { "type": "object", - "properties": { - "has_next": { - "type": "boolean", - "description": "Indicates whether there is a next page." - }, - "has_previous": { - "type": "boolean", - "description": "Indicates whether there is a previous page." - }, - "next": { - "type": "string", - "description": "The cursor to the next page." - }, - "previous": { - "type": "string", - "description": "The cursor to the previous page." - } + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" }, - "description": "Information about the current page." + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" } } + } + } + } + }, + "200": { + "description": "Duplicate github_file resource already exists", + "content": { + "application/json": { + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] }, "examples": { "default": { "value": { - "attestations_subject_digests": [ - { - "sha256:abc": [ - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - }, - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - } - ] - } - ] + "id": 1, + "resource_type": "github_file", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "attestations" - } - } - }, - "/users/{username}/attestations/delete-request": { - "post": { - "summary": "Delete attestations in bulk", - "description": "Delete artifact attestations in bulk by either subject digests or unique ID.", - "tags": [ - "users" - ], - "operationId": "users/delete-attestations-bulk", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk" - }, - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "oneOf": [ - { - "properties": { - "subject_digests": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of subject digests associated with the artifact attestations to delete.", - "minItems": 1, - "maxItems": 1024 - } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "required": [ - "subject_digests" - ] - }, - { - "properties": { - "attestation_ids": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "List of unique IDs associated with the artifact attestations to delete.", - "minItems": 1, - "maxItems": 1024 - } + "documentation_url": { + "type": "string" }, - "required": [ - "attestation_ids" - ] - } - ], - "description": "The request body must include either `subject_digests` or `attestation_ids`, but not both." - }, - "examples": { - "by-subject-digests": { - "summary": "Delete by subject digests", - "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" - ] - } - }, - "by-attestation-ids": { - "summary": "Delete by attestation IDs", - "value": { - "attestation_ids": [ - 111, - 222 - ] + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } } } } - } - }, - "responses": { - "200": { - "description": "Response" }, "404": { "description": "Resource not found", @@ -737648,27 +750941,101 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "attestations" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" } } }, - "/users/{username}/attestations/digest/{subject_digest}": { - "delete": { - "summary": "Delete attestations by subject digest", - "description": "Delete an artifact attestation by subject digest.", + "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}": { + "get": { + "summary": "Get a resource for a Copilot Space for a user", + "description": "Gets a specific resource attached to a Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/delete-attestations-by-subject-digest", + "operationId": "copilot-spaces/get-resource-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest" + "url": "https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-a-copilot-space-for-a-user" }, "parameters": [ { @@ -737681,22 +751048,125 @@ } }, { - "name": "subject_digest", - "description": "Subject Digest", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { - "type": "string" - }, - "x-multi-segment": true + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { "200": { - "description": "Response" + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } }, - "204": { - "description": "Response" + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } }, "404": { "description": "Resource not found", @@ -737726,24 +751196,21 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "attestations" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/users/{username}/attestations/{attestation_id}": { - "delete": { - "summary": "Delete attestations by ID", - "description": "Delete an artifact attestation by unique ID that is associated with a repository owned by a user.", + }, + "put": { + "summary": "Set a resource for a Copilot Space for a user", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/delete-attestations-by-id", + "operationId": "copilot-spaces/update-resource-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/users/attestations#delete-attestations-by-id" + "url": "https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-a-copilot-space-for-a-user" }, "parameters": [ { @@ -737756,8 +751223,17 @@ } }, { - "name": "attestation_id", - "description": "Attestation ID", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", "in": "path", "required": true, "schema": { @@ -737765,12 +751241,108 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "Updated resource-specific metadata.", + "additionalProperties": true + } + } + }, + "examples": { + "default": { + "value": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + } + } + } + } + } + }, "responses": { "200": { - "description": "Response" - }, - "204": { - "description": "Response" + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" + } + } + } + } + } }, "403": { "description": "Forbidden", @@ -737823,56 +751395,101 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "attestations" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/users/{username}/attestations/{subject_digest}": { - "get": { - "summary": "List attestations", - "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + }, + "delete": { + "summary": "Delete a resource from a Copilot Space for a user", + "description": "Deletes a resource from a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/list-attestations", + "operationId": "copilot-spaces/delete-resource-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/users/attestations#list-attestations" + "url": "https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-a-copilot-space-for-a-user" }, "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, { "name": "username", "description": "The handle for the GitHub user account.", @@ -737883,207 +751500,54 @@ } }, { - "name": "subject_digest", - "description": "Subject Digest", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { - "type": "string" - }, - "x-multi-segment": true + "type": "integer" + } }, { - "name": "predicate_type", - "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", - "in": "query", - "required": false, + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "attestations": { - "type": "array", - "items": { - "type": "object", - "properties": { - "repository_id": { - "type": "integer" - }, - "bundle_url": { - "type": "string" - }, - "initiator": { - "type": "string" - } - } - } - } - } - }, - "examples": { - "default": { - "value": { - "attestations": [ - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - }, - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - } - ] + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "204": { - "description": "Response" - }, "404": { "description": "Resource not found", "content": { @@ -738112,10 +751576,9 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "attestations" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" } } }, @@ -779609,7 +793072,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1008128,7 +1021591,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1011247,7 +1024710,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1014271,7 +1027734,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1017295,7 +1030758,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1020453,7 +1033916,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1023618,7 +1037081,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1028782,7 +1042245,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index 11ec1ffe67..a8d81b4ccb 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -73,10 +73,15 @@ tags: description: Interact with GitHub Teams. - name: users description: Interact with and view information about users and also current user. +- name: code-quality + description: Insights into reliability, maintainability, and efficiency of your + codebase. - name: codespaces description: Endpoints to manage Codespaces using the REST API. - name: copilot description: Endpoints to manage Copilot using the REST API. +- name: copilot-spaces + description: Endpoints to manage Copilot Spaces using the REST API. - name: security-advisories description: Manage security advisories. - name: interactions @@ -876,7 +881,7 @@ paths: - subscriptions_url - type - url - type: &316 + type: &320 type: string description: The type of credit the user is receiving. enum: @@ -1041,7 +1046,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &640 + - &644 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1623,7 +1628,7 @@ paths: schema: type: integer default: 30 - - &206 + - &210 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1632,7 +1637,7 @@ paths: required: false schema: type: string - - &207 + - &211 name: status description: Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries @@ -1652,7 +1657,7 @@ paths: application/json: schema: type: array - items: &208 + items: &212 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1748,7 +1753,7 @@ paths: - installation_id - repository_id examples: - default: &209 + default: &213 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1883,7 +1888,7 @@ paths: description: Response content: application/json: - schema: &210 + schema: &214 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -2018,7 +2023,7 @@ paths: - request - response examples: - default: &211 + default: &215 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2559,7 +2564,7 @@ paths: organization_copilot_agent_settings: type: string description: The level of permission to grant the access - token to view and manage Copilot coding agent settings + token to view and manage Copilot cloud agent settings for an organization. enum: - read @@ -9479,9 +9484,9 @@ paths: put: summary: Set the coding agent policy for an enterprise description: |- - Sets the policy for Copilot coding agent usage across an enterprise. + Sets the policy for Copilot cloud agent usage across an enterprise. - Enterprise owners can configure whether Copilot coding agent is enabled for all + Enterprise owners can configure whether Copilot cloud agent is enabled for all organizations, disabled for all organizations, configured by individual organization admins, or enabled for selected organizations only. @@ -9506,7 +9511,7 @@ paths: properties: policy_state: type: string - description: The policy state for Copilot coding agent in the enterprise. + description: The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`. enum: @@ -9532,7 +9537,7 @@ paths: post: summary: Add organizations to the enterprise coding agent policy description: |- - Enables Copilot coding agent for the specified organizations within the enterprise. + Enables Copilot cloud agent for the specified organizations within the enterprise. The enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before using this endpoint. Organizations can be specified by login or matched via custom properties. @@ -9551,7 +9556,7 @@ paths: parameters: - *38 requestBody: - description: The organizations to enable Copilot coding agent for + description: The organizations to enable Copilot cloud agent for required: true content: application/json: @@ -9561,7 +9566,7 @@ paths: organizations: type: array description: List of organization logins within the enterprise to - enable Copilot coding agent for. + enable Copilot cloud agent for. items: type: string custom_properties: @@ -9607,7 +9612,7 @@ paths: delete: summary: Remove organizations from the enterprise coding agent policy description: |- - Disables Copilot coding agent for the specified organizations within the enterprise. + Disables Copilot cloud agent for the specified organizations within the enterprise. The enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before using this endpoint. Organizations can be specified by login or matched via custom properties. @@ -9626,7 +9631,7 @@ paths: parameters: - *38 requestBody: - description: The organizations to disable Copilot coding agent for + description: The organizations to disable Copilot cloud agent for required: true content: application/json: @@ -9636,7 +9641,7 @@ paths: organizations: type: array description: List of organization logins within the enterprise to - disable Copilot coding agent for. + disable Copilot cloud agent for. items: type: string custom_properties: @@ -9699,7 +9704,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *38 - - &189 + - &193 name: classification in: query description: |- @@ -9708,7 +9713,7 @@ paths: Can be: `malware`, `general` schema: type: string - - &190 + - &194 name: state in: query description: |- @@ -9717,7 +9722,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &191 + - &195 name: severity in: query description: |- @@ -9726,7 +9731,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &192 + - &196 name: ecosystem in: query description: |- @@ -9735,14 +9740,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &193 + - &197 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &194 + - &198 name: epss_percentage in: query description: |- @@ -9754,7 +9759,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &475 + - &479 name: has in: query description: |- @@ -9768,7 +9773,7 @@ paths: type: string enum: - patch - - &195 + - &199 name: assignee in: query description: |- @@ -9777,7 +9782,7 @@ paths: Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. schema: type: string - - &196 + - &200 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -9787,7 +9792,7 @@ paths: enum: - development - runtime - - &197 + - &201 name: sort in: query description: |- @@ -9813,7 +9818,7 @@ paths: application/json: schema: type: array - items: &198 + items: &202 type: object description: A Dependabot alert. properties: @@ -9884,7 +9889,7 @@ paths: - transitive - inconclusive - - security_advisory: &476 + security_advisory: &480 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -10136,7 +10141,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &477 + auto_dismissed_at: &481 type: - string - 'null' @@ -10144,7 +10149,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissal_request: &478 + dismissal_request: &482 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -10207,7 +10212,7 @@ paths: - repository additionalProperties: false examples: - default: &199 + default: &203 value: - number: 2 state: dismissed @@ -10592,7 +10597,7 @@ paths: description: Response content: application/json: - schema: &200 + schema: &204 title: Dependabot Repository Access Details description: Information about repositories that Dependabot is able to access in an organization @@ -10618,7 +10623,7 @@ paths: - *65 additionalProperties: false examples: - default: &201 + default: &205 value: default_level: public accessible_repositories: @@ -11832,7 +11837,7 @@ paths: properties: action: type: string - discussion: &730 + discussion: &735 title: Discussion description: A Discussion in a repository. type: object @@ -12329,7 +12334,7 @@ paths: milestone: anyOf: - type: 'null' - - &268 + - &272 title: Milestone description: A collection of related issues and pull requests. @@ -12506,7 +12511,7 @@ paths: timeline_url: type: string format: uri - type: &232 + type: &236 title: Issue Type description: The type of issue. type: @@ -12617,7 +12622,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &651 + sub_issues_summary: &655 title: Sub-issues Summary type: object properties: @@ -12701,7 +12706,7 @@ paths: pin: anyOf: - type: 'null' - - &550 + - &554 title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. @@ -12728,7 +12733,7 @@ paths: - url - created_at - updated_at - issue_dependencies_summary: &652 + issue_dependencies_summary: &656 title: Issue Dependencies Summary type: object properties: @@ -12747,7 +12752,7 @@ paths: - total_blocking issue_field_values: type: array - items: &534 + items: &538 title: Issue Field Value description: A value assigned to an issue field type: object @@ -13527,7 +13532,7 @@ paths: type: string release: allOf: - - &582 + - &586 title: Release description: A release. type: object @@ -13609,7 +13614,7 @@ paths: author: *4 assets: type: array - items: &583 + items: &587 title: Release Asset description: Data related to a release. type: object @@ -15865,7 +15870,7 @@ paths: - closed - all default: open - - &235 + - &239 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -15916,7 +15921,7 @@ paths: type: array items: *82 examples: - default: &236 + default: &240 value: - id: 1 node_id: MDU6SXNzdWUx @@ -17328,14 +17333,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &327 + - &331 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &328 + - &332 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -17397,7 +17402,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &331 + '301': &335 description: Moved permanently content: application/json: @@ -17419,7 +17424,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &558 + - &562 name: all description: If `true`, show notifications marked as read. in: query @@ -17427,7 +17432,7 @@ paths: schema: type: boolean default: false - - &559 + - &563 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -17437,7 +17442,7 @@ paths: type: boolean default: false - *87 - - &560 + - &564 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -17817,7 +17822,7 @@ paths: type: boolean examples: - false - security_and_analysis: &283 + security_and_analysis: &287 type: - object - 'null' @@ -18028,7 +18033,7 @@ paths: - url - subscription_url examples: - default: &561 + default: &565 value: - id: '1' repository: @@ -19332,7 +19337,7 @@ paths: required: false schema: type: string - - &707 + - &712 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -19478,7 +19483,7 @@ paths: parameters: - *74 - *116 - - &708 + - &713 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -19590,7 +19595,7 @@ paths: - *116 - *118 - *117 - - &709 + - &714 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -19598,7 +19603,7 @@ paths: schema: type: string - *119 - - &710 + - &715 name: sku description: The SKU to query for usage. in: query @@ -20567,7 +20572,7 @@ paths: type: integer repository_cache_usages: type: array - items: &338 + items: &342 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -21835,6 +21840,12 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the + name-based format. + type: boolean required: - include_claim_keys examples: @@ -21876,6 +21887,12 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the name-based + format. + type: boolean examples: default: *136 responses: @@ -21943,7 +21960,7 @@ paths: - all - local_only - selected - selected_actions_url: &344 + selected_actions_url: &348 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` @@ -22026,7 +22043,7 @@ paths: description: Response content: application/json: - schema: &348 + schema: &352 type: object properties: days: @@ -22068,7 +22085,7 @@ paths: required: true content: application/json: - schema: &349 + schema: &353 type: object properties: days: @@ -22125,7 +22142,7 @@ paths: required: - approval_policy examples: - default: &350 + default: &354 value: approval_policy: first_time_contributors '404': *6 @@ -22184,7 +22201,7 @@ paths: description: Response content: application/json: - schema: &351 + schema: &355 type: object required: - run_workflows_from_fork_pull_requests @@ -22238,7 +22255,7 @@ paths: required: true content: application/json: - schema: &352 + schema: &356 type: object required: - run_workflows_from_fork_pull_requests @@ -22873,7 +22890,7 @@ paths: description: Response content: application/json: - schema: &353 + schema: &357 type: object properties: default_workflow_permissions: &146 @@ -22924,7 +22941,7 @@ paths: required: false content: application/json: - schema: &354 + schema: &358 type: object properties: default_workflow_permissions: *146 @@ -23417,7 +23434,7 @@ paths: type: array items: *153 examples: - default: &188 + default: &192 value: total_count: 1 repositories: @@ -24064,7 +24081,7 @@ paths: application/json: schema: type: array - items: &355 + items: &359 title: Runner Application description: Runner Application type: object @@ -24089,7 +24106,7 @@ paths: - download_url - filename examples: - default: &356 + default: &360 value: - os: osx architecture: x64 @@ -24175,7 +24192,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &357 + '201': &361 description: Response content: application/json: @@ -24290,7 +24307,7 @@ paths: - token - expires_at examples: - default: &358 + default: &362 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -24329,7 +24346,7 @@ paths: application/json: schema: *157 examples: - default: &359 + default: &363 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -24363,7 +24380,7 @@ paths: application/json: schema: *155 examples: - default: &360 + default: &364 value: id: 23 name: MBP @@ -24589,7 +24606,7 @@ paths: - *74 - *154 responses: - '200': &361 + '200': &365 description: Response content: application/json: @@ -24646,7 +24663,7 @@ paths: parameters: - *74 - *154 - - &362 + - &366 name: name description: The name of a self-hosted runner's custom label. in: path @@ -24778,7 +24795,7 @@ paths: description: Response content: application/json: - schema: &374 + schema: &378 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -24813,7 +24830,7 @@ paths: - key_id - key examples: - default: &375 + default: &379 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -25226,7 +25243,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *74 - - &343 + - &347 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -26459,12 +26476,12 @@ paths: required: - subject_digests examples: - default: &689 + default: &693 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &690 + withPredicateType: &694 value: subject_digests: - sha256:abc123 @@ -26509,7 +26526,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &691 + default: &695 value: attestations_subject_digests: - sha256:abc: @@ -26842,7 +26859,7 @@ paths: initiator: type: string examples: - default: &388 + default: &392 value: attestations: - bundle: @@ -27118,7 +27135,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &187 + items: &191 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -27195,7 +27212,7 @@ paths: parent: anyOf: - type: 'null' - - &247 + - &251 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -27798,7 +27815,7 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *74 - - &412 + - &416 name: tool_name description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, @@ -27808,7 +27825,7 @@ paths: schema: &178 type: string description: The name of the tool used to generate the code scanning analysis. - - &413 + - &417 name: tool_guid description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in @@ -27832,7 +27849,7 @@ paths: be returned. in: query required: false - schema: &415 + schema: &419 type: string description: State of a code scanning alert. enum: @@ -27855,7 +27872,7 @@ paths: be returned. in: query required: false - schema: &416 + schema: &420 type: string description: Severity of a code scanning alert. enum: @@ -27889,7 +27906,7 @@ paths: updated_at: *173 url: *174 html_url: *175 - instances_url: &417 + instances_url: &421 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -27911,7 +27928,7 @@ paths: - type: 'null' - *4 dismissed_at: *177 - dismissed_reason: &418 + dismissed_reason: &422 type: - string - 'null' @@ -27922,14 +27939,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &419 + dismissed_comment: &423 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &420 + rule: &424 type: object properties: id: @@ -27990,7 +28007,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &421 + tool: &425 type: object properties: name: *178 @@ -28001,26 +28018,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *179 - most_recent_instance: &422 + most_recent_instance: &426 type: object properties: - ref: &414 + ref: &418 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &432 + analysis_key: &436 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - environment: &433 + environment: &437 type: string description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &434 + category: &438 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -28040,7 +28057,7 @@ paths: with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance. - location: &435 + location: &439 type: object description: Describe a region within a file for the alert. properties: @@ -28061,7 +28078,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: &436 + items: &440 type: - string - 'null' @@ -29362,7 +29379,7 @@ paths: type: integer codespaces: type: array - items: &237 + items: &241 type: object title: Codespace description: A codespace. @@ -29397,7 +29414,7 @@ paths: machine: anyOf: - type: 'null' - - &448 + - &452 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -29684,7 +29701,7 @@ paths: - pulls_url - recent_folders examples: - default: &238 + default: &242 value: total_count: 3 codespaces: @@ -30349,7 +30366,7 @@ paths: - updated_at - visibility examples: - default: &449 + default: &453 value: total_count: 2 secrets: @@ -30387,7 +30404,7 @@ paths: description: Response content: application/json: - schema: &450 + schema: &454 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -30422,7 +30439,7 @@ paths: - key_id - key examples: - default: &451 + default: &455 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -30454,7 +30471,7 @@ paths: application/json: schema: *186 examples: - default: &453 + default: &457 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -30736,6 +30753,1597 @@ paths: enabledForGitHubApps: false category: codespaces subcategory: organization-secrets + "/orgs/{org}/copilot-spaces": + get: + summary: List organization Copilot Spaces + description: |- + Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces. + + Only Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-organization-copilot-spaces + parameters: + - *74 + - name: per_page + description: The number of results per page (max 100). + in: query + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: before + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + in: query + schema: + type: string + - name: after + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. + in: query + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - spaces + properties: + spaces: + type: array + description: The list of Copilot Spaces on this page of results. + items: &187 + title: Space + description: A GitHub Copilot Space represents an interactive + AI workspace where users can ask questions and get assistance. + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the space. + examples: + - 42 + number: + type: integer + description: The number that identifies the space within + its owner. + examples: + - 1 + name: + type: string + description: The display name of the space. + examples: + - My Development Space + description: + type: + - string + - 'null' + description: A description of the space. + examples: + - A space for discussing React development patterns + general_instructions: + type: + - string + - 'null' + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Help with React development patterns and best practices + base_role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: |- + The base role that determines default permissions. + - `no_access`: No default access + - `reader`: Default read permissions + - `writer`: Default write permissions (organization spaces only) + - `admin`: Default admin permissions (organization spaces only) + examples: + - no_access + owner: + anyOf: + - *4 + - *72 + description: The user or organization that owns this space. + creator: *4 + created_at: + type: string + format: date-time + description: The date and time the space was created. + examples: + - '2023-01-01T00:00:00Z' + updated_at: + type: string + format: date-time + description: The date and time the space was last updated. + examples: + - '2023-01-01T12:00:00Z' + html_url: + type: string + format: uri + description: The HTML URL of the space. + examples: + - https://github.com/copilot/spaces/octo-org/5 + api_url: + type: string + format: uri + description: The API URL of the space. + examples: + - https://api.github.com/organizations/1/copilot-spaces/5 + resources_attributes: + type: array + description: Resources attached to the space. + items: + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the resource. + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + copilot_chat_attachment_id: + type: + - integer + - 'null' + format: int64 + description: The unique identifier of the chat attachment + for uploaded files or media content. + created_at: + type: string + format: date-time + description: The date and time the resource was created. + updated_at: + type: string + format: date-time + description: The date and time the resource was last + updated. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file + resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + copilot_chat_attachment_id: + type: integer + description: Chat attachment ID for uploaded files + or media. + media_type: + type: string + description: Media type for media content resources. + url: + type: string + description: URL for media content resources. + height: + type: integer + description: Height for media content resources. + width: + type: integer + description: Width for media content resources. + required: + - id + - number + - name + - base_role + - owner + - creator + - created_at + - updated_at + - html_url + - api_url + additionalProperties: false + examples: + default: + summary: Example response for listing organization copilot spaces + value: + spaces: + - id: 84 + number: 3 + name: Team Planning Space + description: Organization space for team planning and coordination + owner: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + gravatar_id: '' + name: octo-org + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: octo-org + html_url: https://github.com/octo-org + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + creator: + login: defunkt + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://github.com/images/error/defunkt_happy.gif + gravatar_id: '' + url: https://api.github.com/users/defunkt + html_url: https://github.com/defunkt + followers_url: https://api.github.com/users/defunkt/followers + following_url: https://api.github.com/users/defunkt/following{/other_user} + gists_url: https://api.github.com/users/defunkt/gists{/gist_id} + starred_url: https://api.github.com/users/defunkt/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/defunkt/subscriptions + organizations_url: https://api.github.com/users/defunkt/orgs + repos_url: https://api.github.com/users/defunkt/repos + events_url: https://api.github.com/users/defunkt/events{/privacy} + received_events_url: https://api.github.com/users/defunkt/received_events + type: User + site_admin: true + created_at: '2023-02-15T08:30:00Z' + updated_at: '2023-02-15T14:45:00Z' + html_url: https://github.com/copilot/spaces/octo-org/3 + api_url: https://api.github.com/organizations/1/copilot-spaces/3 + - id: 85 + number: 4 + name: Development Resources + description: Shared development documentation and resources + owner: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + gravatar_id: '' + name: octo-org + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: octo-org + html_url: https://github.com/octo-org + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + creator: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-16T10:15:00Z' + updated_at: '2023-02-16T16:30:00Z' + html_url: https://github.com/copilot/spaces/octo-org/4 + api_url: https://api.github.com/organizations/1/copilot-spaces/4 + headers: + Link: *66 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + post: + summary: Create an organization Copilot Space + description: |- + Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization. + + Organization members with appropriate permissions can create Copilot Spaces to be shared within their organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-an-organization-copilot-space + parameters: + - *74 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - Team Planning Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Organization space for team planning and coordination + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Help the team with planning and coordination tasks + base_role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: |- + The base role that determines default permissions for organization members. + - `no_access`: No default access (default) + - `reader`: Organization members can read the space + - `writer`: Organization members can read and edit the space + - `admin`: Organization members have full admin access to the space + default: no_access + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + required: + - name + examples: + default: + value: + name: Team Planning Space + description: Organization space for team planning and coordination + general_instructions: Help the team with planning and coordination + tasks + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 123456 + file_path: docs/planning.md + - resource_type: free_text + metadata: + name: Team Guidelines + text: Our team follows agile methodology and holds daily standups + responses: + '201': + description: Response + content: + application/json: + schema: *187 + examples: + default: &188 + summary: Example response for an organization copilot space + value: + id: 84 + number: 3 + name: Team Planning Space + description: Organization space for team planning and coordination + general_instructions: Help the team with agile planning, sprint + coordination, and project management best practices + owner: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + gravatar_id: '' + name: octo-org + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: octo-org + html_url: https://github.com/octo-org + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + creator: + login: defunkt + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://github.com/images/error/defunkt_happy.gif + gravatar_id: '' + url: https://api.github.com/users/defunkt + html_url: https://github.com/defunkt + followers_url: https://api.github.com/users/defunkt/followers + following_url: https://api.github.com/users/defunkt/following{/other_user} + gists_url: https://api.github.com/users/defunkt/gists{/gist_id} + starred_url: https://api.github.com/users/defunkt/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/defunkt/subscriptions + organizations_url: https://api.github.com/users/defunkt/orgs + repos_url: https://api.github.com/users/defunkt/repos + events_url: https://api.github.com/users/defunkt/events{/privacy} + received_events_url: https://api.github.com/users/defunkt/received_events + type: User + site_admin: true + created_at: '2023-02-15T08:30:00Z' + updated_at: '2023-02-15T14:45:00Z' + html_url: https://github.com/copilot/spaces/octo-org/3 + api_url: https://api.github.com/organizations/1/copilot-spaces/3 + base_role: no_access + resources_attributes: + - id: 123 + resource_type: github_file + metadata: + repository_id: 456 + file_path: docs/planning.md + - id: 124 + resource_type: free_text + metadata: + name: Team Guidelines + text: Our team follows agile methodology + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + "/orgs/{org}/copilot-spaces/{space_number}": + get: + summary: Get an organization Copilot Space + description: |- + Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space. + + Internal Spaces require the authenticated user to be a member of the organization or have been granted read permissions. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *187 + examples: + default: *188 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + put: + summary: Set an organization Copilot Space + description: |- + Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization. + + Organization members with appropriate permissions can update Copilot Spaces owned by their organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - Updated Team Planning Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Updated organization space for team planning and coordination + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Updated instructions to help the team with planning and coordination + tasks + base_role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: |- + The base role that determines default permissions for organization members. Changing this field requires admin permissions. + - `no_access`: No default access (default) + - `reader`: Organization members can read the space + - `writer`: Organization members can read and edit the space + - `admin`: Organization members have full admin access to the space + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + examples: + default: + value: + name: Updated Team Planning Space + description: Updated organization space for team planning and coordination + general_instructions: Updated instructions to help the team with + planning and coordination tasks + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 123456 + file_path: docs/updated-planning.md + - id: 789 + _destroy: true + - id: 456 + resource_type: free_text + metadata: + name: Updated Team Guidelines + text: Our updated team follows agile methodology and holds daily + standups + responses: + '200': + description: Response + content: + application/json: + schema: *187 + examples: + default: *188 + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + delete: + summary: Delete an organization Copilot Space + description: |- + Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization. + + **Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations. + + Organization members with appropriate permissions can delete Copilot Spaces owned by their organization. + + OAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '204': + description: The Copilot Space has been successfully deleted. + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + "/orgs/{org}/copilot-spaces/{space_number}/collaborators": + get: + summary: List collaborators for an organization Copilot Space + description: |- + Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators. + + Each collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list. + + **Note:** Team collaborators listed here are teams that are defined in the organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-collaborators-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - collaborators + properties: + collaborators: + type: array + description: The list of collaborators for this Copilot Space. + items: &189 + title: Copilot Space Collaborator + description: A collaborator (user or team) of a Copilot Space + type: object + anyOf: + - allOf: + - *4 + - type: object + properties: + actor_type: + type: string + enum: + - User + description: The collaborator actor type. + role: + type: string + enum: + - reader + - writer + - admin + description: The role granted to the collaborator + required: + - actor_type + - role + - type: object + properties: + actor_type: + type: string + enum: + - Team + description: The collaborator actor type. + role: + type: string + enum: + - reader + - writer + - admin + description: The role granted to the collaborator + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + type: + type: string + enum: + - Team + description: + type: + - string + - 'null' + privacy: + type: string + notification_setting: + type: string + url: + type: string + format: uri + html_url: + type: string + format: uri + members_url: + type: string + repositories_url: + type: string + format: uri + organization_id: + type: integer + parent: + type: + - 'null' + required: + - actor_type + - role + - id + - node_id + - name + - slug + - type + examples: + default: + value: + collaborators: + - actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + - actor_type: Team + role: reader + id: 67890 + node_id: MDQ6VGVhbTY3ODkw + url: https://api.github.com/teams/67890 + html_url: https://github.com/orgs/octo-org/teams/developers + name: Developers + slug: developers + description: Team of developers + privacy: closed + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/67890/members{/member} + repositories_url: https://api.github.com/teams/67890/repos + parent: + created_at: '2017-07-14T16:53:42Z' + updated_at: '2017-08-17T12:37:15Z' + organization: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + post: + summary: Add a collaborator to an organization Copilot Space + description: |- + Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. + + **Note:** When adding users as collaborators, they must already be members of the organization. + When adding teams as collaborators, they must be defined in the organization. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/add-collaborator-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - actor_type + - actor_identifier + - role + properties: + actor_type: + type: string + enum: + - User + - Team + description: The type of actor (user or team). + actor_identifier: + type: string + description: The username (for users) or team slug (for teams). + The numeric ID of a user or team is also accepted. + role: + type: string + enum: + - reader + - writer + - admin + description: The role to grant to the collaborator. + examples: + user: + value: + actor_type: User + actor_identifier: octocat + role: writer + team: + value: + actor_type: Team + actor_identifier: developers + role: reader + responses: + '201': + description: Response + content: + application/json: + schema: *189 + examples: + user: + value: + actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + team: + value: + actor_type: Team + role: reader + id: 67890 + node_id: MDQ6VGVhbTY3ODkw + url: https://api.github.com/teams/67890 + html_url: https://github.com/orgs/octo-org/teams/developers + name: Developers + slug: developers + type: Team + description: Team of developers + privacy: closed + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/67890/members{/member} + repositories_url: https://api.github.com/teams/67890/repos + parent: + organization_id: 1 + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": + put: + summary: Set a collaborator role for an organization Copilot Space + description: |- + Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-collaborator-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (user or team). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username (for users) or team slug (for teams). The numeric + ID of a user or team is also accepted. + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - role + properties: + role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: The new role to grant to the collaborator. Use `no_access` + to remove the collaborator. + examples: + default: + value: + role: admin + responses: + '200': + description: Response + content: + application/json: + schema: *189 + examples: + user: + value: + actor_type: User + role: admin + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + team: + value: + actor_type: Team + role: admin + id: 67890 + node_id: MDQ6VGVhbTY3ODkw + url: https://api.github.com/teams/67890 + html_url: https://github.com/orgs/octo-org/teams/developers + name: Developers + slug: developers + type: Team + description: Team of developers + privacy: closed + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/67890/members{/member} + repositories_url: https://api.github.com/teams/67890/repos + parent: + organization_id: 1 + '204': + description: Response when `role` is `no_access` and the collaborator was + removed. + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + delete: + summary: Remove a collaborator from an organization Copilot Space + description: |- + Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/remove-collaborator-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (user or team). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username (for users) or team slug (for teams). The numeric + ID of a user or team is also accepted. + in: path + required: true + schema: + type: string + responses: + '204': + description: Response + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + "/orgs/{org}/copilot-spaces/{space_number}/resources": + get: + summary: List resources for an organization Copilot Space + description: |- + Lists all resources attached to a specific Copilot Space owned by an organization. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-resources-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - resources + properties: + resources: + type: array + description: The list of resources attached to this Copilot Space. + items: &190 + title: Copilot Space Resource + description: A resource attached to a Copilot Space. + type: object + properties: + id: + type: integer + description: The unique identifier of the resource. + resource_type: + type: string + description: The type of the resource. + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + copilot_chat_attachment_id: + type: + - integer + - 'null' + description: The ID of the associated chat attachment, if + any. + metadata: + type: object + description: Resource-specific metadata. The keys and values + depend on the resource type. + additionalProperties: true + created_at: + type: string + format: date-time + description: The date and time the resource was created. + updated_at: + type: string + format: date-time + description: The date and time the resource was last updated. + required: + - id + - resource_type + - metadata + - created_at + - updated_at + examples: + default: + value: + resources: + - id: 1 + resource_type: repository + copilot_chat_attachment_id: + metadata: + repository_id: 42 + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + - id: 2 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + post: + summary: Create a resource for an organization Copilot Space + description: |- + Creates a new resource in a specific Copilot Space owned by an organization. + The authenticated user must have write permissions on the space. + + The following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`. + The `uploaded_text_file` and `media_content` types are not supported via this endpoint. + + For `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - resource_type + - metadata + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + description: The type of resource to create. + metadata: + type: object + description: Resource-specific metadata. + additionalProperties: true + examples: + free_text: + value: + resource_type: free_text + metadata: + name: notes.txt + text: Some helpful notes + repository: + value: + resource_type: repository + metadata: + repository_id: 42 + github_file: + value: + resource_type: github_file + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + responses: + '201': + description: Resource created + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '200': + description: Duplicate github_file resource already exists + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: github_file + copilot_chat_attachment_id: + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": + get: + summary: Get a resource for an organization Copilot Space + description: |- + Gets a specific resource attached to a Copilot Space owned by an organization. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + put: + summary: Set a resource for an organization Copilot Space + description: |- + Updates the metadata of a resource in a specific Copilot Space owned by an organization. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + description: Updated resource-specific metadata. + additionalProperties: true + examples: + default: + value: + metadata: + name: updated-notes.txt + text: Updated content + responses: + '200': + description: Response + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: updated-notes.txt + text: Updated content + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T12:00:00Z' + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + delete: + summary: Delete a resource from an organization Copilot Space + description: |- + Deletes a resource from a specific Copilot Space owned by an organization. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources "/orgs/{org}/copilot/billing": get: summary: Get Copilot seat information and settings for an organization @@ -30921,7 +32529,7 @@ paths: currently being billed. seats: type: array - items: &240 + items: &244 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -30939,7 +32547,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *187 + - *191 - *67 type: - 'null' @@ -31398,15 +33006,15 @@ paths: subcategory: copilot-user-management "/orgs/{org}/copilot/coding-agent/permissions": get: - summary: Get Copilot coding agent permissions for an organization + summary: Get Copilot cloud agent permissions for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Gets information about which repositories in an organization have been enabled - or disabled for the Copilot coding agent. + or disabled for the Copilot cloud agent. - Organization owners can configure whether Copilot coding agent is enabled for + Organization owners can configure whether Copilot cloud agent is enabled for all repositories, selected repositories, or no repositories owned by organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -31415,7 +33023,7 @@ paths: operationId: copilot/get-copilot-coding-agent-permissions-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-cloud-agent-permissions-for-an-organization parameters: - *74 responses: @@ -31429,7 +33037,7 @@ paths: enabled_repositories: type: string description: The policy for which repositories can use Copilot - coding agent. Can be one of `all`, `selected`, or `none`. + cloud agent. Can be one of `all`, `selected`, or `none`. enum: - all - selected @@ -31464,14 +33072,14 @@ paths: category: copilot subcategory: copilot-coding-agent-management put: - summary: Set Copilot coding agent permissions for an organization + summary: Set Copilot cloud agent permissions for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. - Sets the policy for which repositories in an organization can use Copilot coding agent. + Sets the policy for which repositories in an organization can use Copilot cloud agent. - Organization owners can configure whether Copilot coding agent is enabled for + Organization owners can configure whether Copilot cloud agent is enabled for all repositories, selected repositories, or no repositories owned by the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -31480,7 +33088,7 @@ paths: operationId: copilot/set-copilot-coding-agent-permissions-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-cloud-agent-permissions-for-an-organization parameters: - *74 requestBody: @@ -31492,7 +33100,7 @@ paths: properties: enabled_repositories: type: string - description: The policy for which repositories can use Copilot coding + description: The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`. enum: - all @@ -31519,12 +33127,12 @@ paths: subcategory: copilot-coding-agent-management "/orgs/{org}/copilot/coding-agent/permissions/repositories": get: - summary: List repositories enabled for Copilot coding agent in an organization + summary: List repositories enabled for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists the selected repositories that are enabled for Copilot coding agent in an organization. + Lists the selected repositories that are enabled for Copilot cloud agent in an organization. Organization owners can use this endpoint when the coding agent repository policy is set to `selected` to see which repositories have been enabled. @@ -31535,7 +33143,7 @@ paths: operationId: copilot/list-copilot-coding-agent-selected-repositories-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-cloud-agent-in-an-organization parameters: - *74 - *17 @@ -31557,7 +33165,7 @@ paths: - total_count - repositories examples: - default: *188 + default: *192 '500': *53 '401': *23 '403': *27 @@ -31569,13 +33177,13 @@ paths: category: copilot subcategory: copilot-coding-agent-management put: - summary: Set selected repositories for Copilot coding agent in an organization + summary: Set selected repositories for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. - Replaces the list of selected repositories that are enabled for Copilot coding - agent in an organization. This method can only be called when the coding agent + Replaces the list of selected repositories that are enabled for Copilot cloud + agent in an organization. This method can only be called when the cloud agent repository policy is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -31584,7 +33192,7 @@ paths: operationId: copilot/set-copilot-coding-agent-selected-repositories-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-cloud-agent-in-an-organization parameters: - *74 requestBody: @@ -31595,7 +33203,7 @@ paths: type: object properties: selected_repository_ids: - description: List of repository IDs to enable for Copilot coding + description: List of repository IDs to enable for Copilot cloud agent. type: array items: @@ -31625,14 +33233,14 @@ paths: subcategory: copilot-coding-agent-management "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}": put: - summary: Enable a repository for Copilot coding agent in an organization + summary: Enable a repository for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Adds a repository to the list of selected repositories enabled for Copilot - coding agent in an organization. This method can only be called when the - coding agent repository policy is set to `selected`. + cloud agent in an organization. This method can only be called when the + cloud agent repository policy is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -31640,7 +33248,7 @@ paths: operationId: copilot/enable-copilot-coding-agent-for-repository-in-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-cloud-agent-in-an-organization parameters: - *74 - *142 @@ -31659,14 +33267,14 @@ paths: category: copilot subcategory: copilot-coding-agent-management delete: - summary: Disable a repository for Copilot coding agent in an organization + summary: Disable a repository for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Removes a repository from the list of selected repositories enabled for Copilot - coding agent in an organization. This method can only be called when the - coding agent repository policy is set to `selected`. + cloud agent in an organization. This method can only be called when the + cloud agent repository policy is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint. tags: @@ -31674,7 +33282,7 @@ paths: operationId: copilot/disable-copilot-coding-agent-for-repository-in-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-cloud-agent-in-an-organization parameters: - *74 - *142 @@ -31892,7 +33500,7 @@ paths: application/json: schema: type: array - items: &320 + items: &324 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -32207,7 +33815,7 @@ paths: - date additionalProperties: true examples: - default: &321 + default: &325 value: - date: '2024-06-24' total_active_users: 24 @@ -32309,7 +33917,7 @@ paths: '500': *53 '403': *27 '404': *6 - '422': &322 + '422': &326 description: Copilot Usage Metrics API setting is disabled at the organization or enterprise level. content: @@ -32489,12 +34097,12 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *74 - - *189 - - *190 - - *191 - - *192 - *193 - *194 + - *195 + - *196 + - *197 + - *198 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -32524,7 +34132,7 @@ paths: enum: - patch - deployment - - *195 + - *199 - name: runtime_risk in: query description: |- @@ -32533,8 +34141,8 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *196 - - *197 + - *200 + - *201 - *60 - *45 - *46 @@ -32546,9 +34154,9 @@ paths: application/json: schema: type: array - items: *198 + items: *202 examples: - default: *199 + default: *203 '304': *35 '400': *14 '403': *27 @@ -32597,9 +34205,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *204 examples: - default: *201 + default: *205 '403': *27 '404': *6 x-github: @@ -32763,7 +34371,7 @@ paths: type: integer secrets: type: array - items: &202 + items: &206 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -32842,7 +34450,7 @@ paths: description: Response content: application/json: - schema: &481 + schema: &485 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -32861,7 +34469,7 @@ paths: - key_id - key examples: - default: &482 + default: &486 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -32891,7 +34499,7 @@ paths: description: Response content: application/json: - schema: *202 + schema: *206 examples: default: value: @@ -33188,7 +34796,7 @@ paths: application/json: schema: type: array - items: &249 + items: &253 title: Package description: A software package type: object @@ -33259,7 +34867,7 @@ paths: - created_at - updated_at examples: - default: &250 + default: &254 value: - id: 197 name: hello_docker @@ -33429,7 +35037,7 @@ paths: application/json: schema: type: array - items: &226 + items: &230 title: Organization Invitation description: Organization Invitation type: object @@ -33483,7 +35091,7 @@ paths: - invitation_teams_url - node_id examples: - default: &227 + default: &231 value: - id: 1 login: monalisa @@ -33550,7 +35158,7 @@ paths: application/json: schema: type: array - items: &203 + items: &207 title: Org Hook description: Org Hook type: object @@ -33735,9 +35343,9 @@ paths: description: Response content: application/json: - schema: *203 + schema: *207 examples: - default: &204 + default: &208 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -33785,7 +35393,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - *74 - - &205 + - &209 name: hook_id description: The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. @@ -33798,9 +35406,9 @@ paths: description: Response content: application/json: - schema: *203 + schema: *207 examples: - default: *204 + default: *208 '404': *6 x-github: githubCloudOnly: false @@ -33828,7 +35436,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - *74 - - *205 + - *209 requestBody: required: false content: @@ -33874,7 +35482,7 @@ paths: description: Response content: application/json: - schema: *203 + schema: *207 examples: default: value: @@ -33916,7 +35524,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - *74 - - *205 + - *209 responses: '204': description: Response @@ -33944,7 +35552,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *74 - - *205 + - *209 responses: '200': description: Response @@ -33975,7 +35583,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *74 - - *205 + - *209 requestBody: required: false content: @@ -34026,10 +35634,10 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *74 - - *205 + - *209 - *17 - - *206 - - *207 + - *210 + - *211 responses: '200': description: Response @@ -34037,9 +35645,9 @@ paths: application/json: schema: type: array - items: *208 + items: *212 examples: - default: *209 + default: *213 '400': *14 '422': *15 x-github: @@ -34065,16 +35673,16 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *74 - - *205 + - *209 - *16 responses: '200': description: Response content: application/json: - schema: *210 + schema: *214 examples: - default: *211 + default: *215 '400': *14 '422': *15 x-github: @@ -34100,7 +35708,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *74 - - *205 + - *209 - *16 responses: '202': *37 @@ -34130,7 +35738,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - *74 - - *205 + - *209 responses: '204': description: Response @@ -34153,7 +35761,7 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - *74 - - &216 + - &220 name: actor_type in: path description: The type of the actor @@ -34166,14 +35774,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &217 + - &221 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &212 + - &216 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -34181,7 +35789,7 @@ paths: required: true schema: type: string - - &213 + - &217 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -34276,12 +35884,12 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - *74 - - *212 - - *213 + - *216 + - *217 - *19 - *17 - *60 - - &222 + - &226 name: sort description: The property to sort the results by. in: query @@ -34360,14 +35968,14 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - *74 - - *212 - - *213 + - *216 + - *217 responses: '200': description: Response content: application/json: - schema: &214 + schema: &218 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -34383,7 +35991,7 @@ paths: type: integer format: int64 examples: - default: &215 + default: &219 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -34404,23 +36012,23 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - *74 - - &218 + - &222 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *212 - - *213 + - *216 + - *217 responses: '200': description: Response content: application/json: - schema: *214 + schema: *218 examples: - default: *215 + default: *219 x-github: enabledForGitHubApps: true category: orgs @@ -34439,18 +36047,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - *74 - - *212 - - *213 - *216 - *217 + - *220 + - *221 responses: '200': description: Response content: application/json: - schema: *214 + schema: *218 examples: - default: *215 + default: *219 x-github: enabledForGitHubApps: true category: orgs @@ -34468,9 +36076,9 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - *74 - - *212 - - *213 - - &219 + - *216 + - *217 + - &223 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -34483,7 +36091,7 @@ paths: description: Response content: application/json: - schema: &220 + schema: &224 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -34499,7 +36107,7 @@ paths: type: integer format: int64 examples: - default: &221 + default: &225 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -34536,18 +36144,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - *74 - - *218 - - *212 - - *213 - - *219 + - *222 + - *216 + - *217 + - *223 responses: '200': description: Response content: application/json: - schema: *220 + schema: *224 examples: - default: *221 + default: *225 x-github: enabledForGitHubApps: true category: orgs @@ -34565,19 +36173,19 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - *74 + - *220 + - *221 - *216 - *217 - - *212 - - *213 - - *219 + - *223 responses: '200': description: Response content: application/json: - schema: *220 + schema: *224 examples: - default: *221 + default: *225 x-github: enabledForGitHubApps: true category: orgs @@ -34595,13 +36203,13 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - *74 - - *218 - - *212 - - *213 + - *222 + - *216 + - *217 - *19 - *17 - *60 - - *222 + - *226 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -34685,7 +36293,7 @@ paths: application/json: schema: *20 examples: - default: &521 + default: &525 value: id: 1 account: @@ -34851,12 +36459,12 @@ paths: application/json: schema: anyOf: - - &224 + - &228 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &223 + limit: &227 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -34884,7 +36492,7 @@ paths: properties: {} additionalProperties: false examples: - default: &225 + default: &229 value: limit: collaborators_only origin: organization @@ -34913,13 +36521,13 @@ paths: required: true content: application/json: - schema: &522 + schema: &526 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *223 + limit: *227 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -34944,9 +36552,9 @@ paths: description: Response content: application/json: - schema: *224 + schema: *228 examples: - default: *225 + default: *229 '422': *15 x-github: githubCloudOnly: false @@ -35022,9 +36630,9 @@ paths: application/json: schema: type: array - items: *226 + items: *230 examples: - default: *227 + default: *231 headers: Link: *66 '404': *6 @@ -35101,7 +36709,7 @@ paths: description: Response content: application/json: - schema: *226 + schema: *230 examples: default: value: @@ -35156,7 +36764,7 @@ paths: url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - *74 - - &228 + - &232 name: invitation_id description: The unique identifier of the invitation. in: path @@ -35187,7 +36795,7 @@ paths: url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - *74 - - *228 + - *232 - *17 - *19 responses: @@ -35197,9 +36805,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - default: &248 + default: &252 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -35242,7 +36850,7 @@ paths: application/json: schema: type: array - items: &229 + items: &233 title: Issue Field description: A custom attribute defined at the organization level for attaching structured data to issues. @@ -35485,9 +37093,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *233 examples: - default: &230 + default: &234 value: id: 512 node_id: IF_kwDNAd3NAZr @@ -35543,7 +37151,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-fields#update-issue-field-for-an-organization parameters: - *74 - - &231 + - &235 name: issue_field_id description: The unique identifier of the issue field. in: path @@ -35653,9 +37261,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *233 examples: - default: *230 + default: *234 '404': *6 '422': *7 x-github: @@ -35680,7 +37288,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-fields#delete-issue-field-for-an-organization parameters: - *74 - - *231 + - *235 responses: '204': *59 '404': *6 @@ -35710,7 +37318,7 @@ paths: application/json: schema: type: array - items: *232 + items: *236 examples: default: value: @@ -35798,9 +37406,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *236 examples: - default: &233 + default: &237 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -35833,7 +37441,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *74 - - &234 + - &238 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -35889,9 +37497,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *236 examples: - default: *233 + default: *237 '404': *6 '422': *7 x-github: @@ -35916,7 +37524,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *74 - - *234 + - *238 responses: '204': description: Response @@ -35979,7 +37587,7 @@ paths: - closed - all default: open - - *235 + - *239 - name: type description: Can be the name of an issue type. in: query @@ -36010,7 +37618,7 @@ paths: type: array items: *82 examples: - default: *236 + default: *240 headers: Link: *66 '404': *6 @@ -36170,9 +37778,9 @@ paths: type: integer codespaces: type: array - items: *237 + items: *241 examples: - default: *238 + default: *242 '304': *35 '500': *53 '401': *23 @@ -36199,7 +37807,7 @@ paths: parameters: - *74 - *70 - - &239 + - &243 name: codespace_name in: path required: true @@ -36234,15 +37842,15 @@ paths: parameters: - *74 - *70 - - *239 + - *243 responses: '200': description: Response content: application/json: - schema: *237 + schema: *241 examples: - default: &447 + default: &451 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -36422,7 +38030,7 @@ paths: description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *240 + schema: *244 examples: default: value: @@ -36498,7 +38106,7 @@ paths: description: Response content: application/json: - schema: &241 + schema: &245 title: Org Membership description: Org Membership type: object @@ -36567,7 +38175,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &242 + response-if-user-has-an-active-admin-membership-with-organization: &246 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -36668,9 +38276,9 @@ paths: description: Response content: application/json: - schema: *241 + schema: *245 examples: - response-if-user-already-had-membership-with-organization: *242 + response-if-user-already-had-membership-with-organization: *246 '422': *15 '403': *27 '451': *15 @@ -36743,7 +38351,7 @@ paths: application/json: schema: type: array - items: &243 + items: &247 title: Migration description: A migration. type: object @@ -37081,7 +38689,7 @@ paths: description: Response content: application/json: - schema: *243 + schema: *247 examples: default: value: @@ -37260,7 +38868,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - *74 - - &244 + - &248 name: migration_id description: The unique identifier of the migration. in: path @@ -37288,7 +38896,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *243 + schema: *247 examples: default: value: @@ -37458,7 +39066,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - *74 - - *244 + - *248 responses: '302': description: Response @@ -37480,7 +39088,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - *74 - - *244 + - *248 responses: '204': description: Response @@ -37504,8 +39112,8 @@ paths: url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - *74 - - *244 - - &671 + - *248 + - &675 name: repo_name description: repo_name parameter in: path @@ -37533,7 +39141,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - *74 - - *244 + - *248 - *17 - *19 responses: @@ -37587,7 +39195,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &246 + items: &250 title: Organization Role description: Organization roles type: object @@ -37764,7 +39372,7 @@ paths: parameters: - *74 - *76 - - &245 + - &249 name: role_id description: The unique identifier of the role. in: path @@ -37801,7 +39409,7 @@ paths: parameters: - *74 - *76 - - *245 + - *249 responses: '204': description: Response @@ -37854,7 +39462,7 @@ paths: parameters: - *74 - *70 - - *245 + - *249 responses: '204': description: Response @@ -37886,7 +39494,7 @@ paths: parameters: - *74 - *70 - - *245 + - *249 responses: '204': description: Response @@ -37915,13 +39523,13 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - *74 - - *245 + - *249 responses: '200': description: Response content: application/json: - schema: *246 + schema: *250 examples: default: value: @@ -37972,7 +39580,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - *74 - - *245 + - *249 - *17 - *19 responses: @@ -38051,7 +39659,7 @@ paths: parent: anyOf: - type: 'null' - - *247 + - *251 type: description: The ownership type of the team type: string @@ -38084,7 +39692,7 @@ paths: - type - parent examples: - default: *248 + default: *252 headers: Link: *66 '404': @@ -38114,7 +39722,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - *74 - - *245 + - *249 - *17 - *19 responses: @@ -38143,7 +39751,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *247 + items: *251 name: type: - string @@ -38453,7 +40061,7 @@ paths: - nuget - container - *74 - - &672 + - &676 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -38489,12 +40097,12 @@ paths: application/json: schema: type: array - items: *249 + items: *253 examples: - default: *250 + default: *254 '403': *27 '401': *23 - '400': &674 + '400': &678 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -38516,7 +40124,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &251 + - &255 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -38534,7 +40142,7 @@ paths: - docker - nuget - container - - &252 + - &256 name: package_name description: The name of the package. in: path @@ -38547,7 +40155,7 @@ paths: description: Response content: application/json: - schema: *249 + schema: *253 examples: default: value: @@ -38599,8 +40207,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *251 - - *252 + - *255 + - *256 - *74 responses: '204': @@ -38633,8 +40241,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *251 - - *252 + - *255 + - *256 - *74 - name: token description: package token @@ -38667,8 +40275,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *251 - - *252 + - *255 + - *256 - *74 - *19 - *17 @@ -38689,7 +40297,7 @@ paths: application/json: schema: type: array - items: &253 + items: &257 title: Package Version description: A version of a software package type: object @@ -38824,10 +40432,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *251 - - *252 + - *255 + - *256 - *74 - - &254 + - &258 name: package_version_id description: Unique identifier of the package version. in: path @@ -38839,7 +40447,7 @@ paths: description: Response content: application/json: - schema: *253 + schema: *257 examples: default: value: @@ -38875,10 +40483,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *251 - - *252 + - *255 + - *256 - *74 - - *254 + - *258 responses: '204': description: Response @@ -38910,10 +40518,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *251 - - *252 + - *255 + - *256 - *74 - - *254 + - *258 responses: '204': description: Response @@ -38943,7 +40551,7 @@ paths: - *74 - *17 - *19 - - &255 + - &259 name: sort description: The property by which to sort the results. in: query @@ -38954,7 +40562,7 @@ paths: - created_at default: created_at - *60 - - &256 + - &260 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -38966,7 +40574,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &257 + - &261 name: repository description: The name of the repository to use to filter the results. in: query @@ -38975,7 +40583,7 @@ paths: type: string examples: - Hello-World - - &258 + - &262 name: permission description: The permission to use to filter the results. in: query @@ -38984,7 +40592,7 @@ paths: type: string examples: - issues_read - - &259 + - &263 name: last_used_before description: 'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -38994,7 +40602,7 @@ paths: schema: type: string format: date-time - - &260 + - &264 name: last_used_after description: 'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -39004,7 +40612,7 @@ paths: schema: type: string format: date-time - - &261 + - &265 name: token_id description: The ID of the token in: query @@ -39323,7 +40931,7 @@ paths: type: array items: *153 examples: - default: &262 + default: &266 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -39460,14 +41068,14 @@ paths: - *74 - *17 - *19 - - *255 - - *60 - - *256 - - *257 - - *258 - *259 + - *60 - *260 - *261 + - *262 + - *263 + - *264 + - *265 responses: '500': *53 '422': *15 @@ -39751,7 +41359,7 @@ paths: type: array items: *153 examples: - default: *262 + default: *266 headers: Link: *66 x-github: @@ -39793,7 +41401,7 @@ paths: type: integer configurations: type: array - items: &263 + items: &267 title: Organization private registry description: Private registry configuration for an organization type: object @@ -40270,7 +41878,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &264 + org-private-registry-with-selected-visibility: &268 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -40368,9 +41976,9 @@ paths: description: The specified private registry configuration for the organization content: application/json: - schema: *263 + schema: *267 examples: - default: *264 + default: *268 '404': *6 x-github: githubCloudOnly: false @@ -40611,7 +42219,7 @@ paths: application/json: schema: type: array - items: &265 + items: &269 title: Projects v2 Project description: A projects v2 project type: object @@ -40685,7 +42293,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &758 + - &763 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -40770,7 +42378,7 @@ paths: - deleted_at - deleted_by examples: - default: &266 + default: &270 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -40873,7 +42481,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-organization parameters: - - &267 + - &271 name: project_number description: The project's number. in: path @@ -40886,9 +42494,9 @@ paths: description: Response content: application/json: - schema: *265 + schema: *269 examples: - default: *266 + default: *270 headers: Link: *66 '304': *35 @@ -40911,7 +42519,7 @@ paths: url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - *74 - - *267 + - *271 requestBody: required: true description: Details of the draft item to create in the project. @@ -40945,7 +42553,7 @@ paths: description: Response content: application/json: - schema: &272 + schema: &276 title: Projects v2 Item description: An item belonging to a project type: object @@ -40959,7 +42567,7 @@ paths: content: oneOf: - *82 - - &462 + - &466 title: Pull Request Simple description: Pull Request Simple type: object @@ -41079,7 +42687,7 @@ paths: milestone: anyOf: - type: 'null' - - *268 + - *272 active_lock_reason: type: - string @@ -41118,7 +42726,7 @@ paths: items: *4 requested_teams: type: array - items: *187 + items: *191 head: type: object properties: @@ -41162,7 +42770,7 @@ paths: _links: type: object properties: - comments: &269 + comments: &273 title: Link description: Hypermedia Link type: object @@ -41171,13 +42779,13 @@ paths: type: string required: - href - commits: *269 - statuses: *269 - html: *269 - issue: *269 - review_comments: *269 - review_comment: *269 - self: *269 + commits: *273 + statuses: *273 + html: *273 + issue: *273 + review_comments: *273 + review_comment: *273 + self: *273 required: - comments - commits @@ -41188,7 +42796,7 @@ paths: - review_comment - self author_association: *79 - auto_merge: &568 + auto_merge: &572 title: Auto merge description: The status of auto merging a pull request. type: @@ -41288,7 +42896,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: &271 + content_type: &275 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -41332,7 +42940,7 @@ paths: - updated_at - archived_at examples: - draft_issue: &273 + draft_issue: &277 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -41406,7 +43014,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization parameters: - - *267 + - *271 - *74 - *17 - *45 @@ -41418,7 +43026,7 @@ paths: application/json: schema: type: array - items: &270 + items: &274 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -41571,7 +43179,7 @@ paths: - updated_at - project_url examples: - default: &694 + default: &699 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -41701,7 +43309,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project parameters: - - *267 + - *271 - *74 requestBody: required: true @@ -41748,7 +43356,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &695 + items: &700 type: object properties: name: @@ -41785,7 +43393,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &696 + iteration_configuration: &701 type: object description: The configuration for iteration fields. properties: @@ -41835,7 +43443,7 @@ paths: value: name: Due date data_type: date - single_select_field: &697 + single_select_field: &702 summary: Create a single select field value: name: Priority @@ -41862,7 +43470,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &698 + iteration_field: &703 summary: Create an iteration field value: name: Sprint @@ -41886,9 +43494,9 @@ paths: description: Response for adding a field to an organization-owned project. content: application/json: - schema: *270 + schema: *274 examples: - text_field: &699 + text_field: &704 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -41897,7 +43505,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-05-15T08:00:00Z' updated_at: '2022-05-15T08:00:00Z' - number_field: &700 + number_field: &705 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -41906,7 +43514,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-01T14:30:00Z' updated_at: '2022-06-01T14:30:00Z' - date_field: &701 + date_field: &706 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -41915,7 +43523,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-10T09:15:00Z' updated_at: '2022-06-10T09:15:00Z' - single_select_field: &702 + single_select_field: &707 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -41949,7 +43557,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &703 + iteration_field: &708 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -41994,8 +43602,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - - *267 - - &704 + - *271 + - &709 name: field_id description: The unique identifier of the field. in: path @@ -42008,9 +43616,9 @@ paths: description: Response content: application/json: - schema: *270 + schema: *274 examples: - default: &705 + default: &710 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -42066,7 +43674,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *267 + - *271 - *74 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) @@ -42099,7 +43707,7 @@ paths: application/json: schema: type: array - items: &274 + items: &278 title: Projects v2 Item description: An item belonging to a project type: object @@ -42116,7 +43724,7 @@ paths: description: The API URL of the project that contains this item. examples: - https://api.github.com/users/monalisa/2/projectsV2/3 - content_type: *271 + content_type: *275 content: type: - object @@ -42166,7 +43774,7 @@ paths: - updated_at - archived_at examples: - default: &275 + default: &279 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -42864,7 +44472,7 @@ paths: url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project parameters: - *74 - - *267 + - *271 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -42934,22 +44542,22 @@ paths: description: Response content: application/json: - schema: *272 + schema: *276 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *273 + value: *277 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *273 + value: *277 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *273 + value: *277 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *273 + value: *277 '304': *35 '403': *27 '401': *23 @@ -42969,9 +44577,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *267 + - *271 - *74 - - &276 + - &280 name: item_id description: The unique identifier of the project item. in: path @@ -42997,9 +44605,9 @@ paths: description: Response content: application/json: - schema: *274 + schema: *278 examples: - default: *275 + default: *279 headers: Link: *66 '304': *35 @@ -43020,9 +44628,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-organization parameters: - - *267 + - *271 - *74 - - *276 + - *280 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -43095,13 +44703,13 @@ paths: description: Response content: application/json: - schema: *274 + schema: *278 examples: - text_field: *275 - number_field: *275 - date_field: *275 - single_select_field: *275 - iteration_field: *275 + text_field: *279 + number_field: *279 + date_field: *279 + single_select_field: *279 + iteration_field: *279 '401': *23 '403': *27 '404': *6 @@ -43121,9 +44729,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization parameters: - - *267 + - *271 - *74 - - *276 + - *280 responses: '204': description: Response @@ -43147,7 +44755,7 @@ paths: url: https://docs.github.com/rest/projects/views#create-a-view-for-an-organization-owned-project parameters: - *74 - - *267 + - *271 requestBody: required: true content: @@ -43221,7 +44829,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &686 + schema: &690 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -43325,7 +44933,7 @@ paths: examples: table_view: summary: Response for creating a table view - value: &277 + value: &281 value: id: 1 number: 1 @@ -43371,10 +44979,10 @@ paths: - 456 board_view: summary: Response for creating a board view with filter - value: *277 + value: *281 roadmap_view: summary: Response for creating a roadmap view - value: *277 + value: *281 '304': *35 '403': *27 '401': *23 @@ -43402,9 +45010,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-project-view parameters: - - *267 + - *271 - *74 - - &706 + - &711 name: view_number description: The number that identifies the project view. in: path @@ -43436,9 +45044,9 @@ paths: application/json: schema: type: array - items: *274 + items: *278 examples: - default: *275 + default: *279 headers: Link: *66 '304': *35 @@ -43471,7 +45079,7 @@ paths: application/json: schema: type: array - items: &278 + items: &282 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -43549,7 +45157,7 @@ paths: - property_name - value_type examples: - default: &279 + default: &283 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -43609,7 +45217,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *278 + items: *282 minItems: 1 maxItems: 100 required: @@ -43639,9 +45247,9 @@ paths: application/json: schema: type: array - items: *278 + items: *282 examples: - default: *279 + default: *283 '403': *27 '404': *6 x-github: @@ -43663,7 +45271,7 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - *74 - - &280 + - &284 name: custom_property_name description: The custom property name in: path @@ -43675,9 +45283,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *282 examples: - default: &281 + default: &285 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -43712,7 +45320,7 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - *74 - - *280 + - *284 requestBody: required: true content: @@ -43792,9 +45400,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *282 examples: - default: *281 + default: *285 '403': *27 '404': *6 x-github: @@ -43818,7 +45426,7 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - *74 - - *280 + - *284 responses: '204': *59 '403': *27 @@ -43882,7 +45490,7 @@ paths: - octocat/Hello-World properties: type: array - items: &282 + items: &286 title: Custom Property Value description: Custom property name and associated value type: object @@ -43972,7 +45580,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *282 + items: *286 required: - repository_names - properties @@ -44164,7 +45772,7 @@ paths: type: array items: *153 examples: - default: *262 + default: *266 headers: Link: *66 x-github: @@ -44367,7 +45975,7 @@ paths: description: Response content: application/json: - schema: &330 + schema: &334 title: Full Repository description: Full Repository type: object @@ -44837,7 +46445,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &467 + code_of_conduct: &471 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -44867,7 +46475,7 @@ paths: - key - name - html_url - security_and_analysis: *283 + security_and_analysis: *287 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -44951,7 +46559,7 @@ paths: - network_count - subscribers_count examples: - default: &332 + default: &336 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -45472,7 +47080,7 @@ paths: - *74 - *17 - *19 - - &590 + - &594 name: targets description: | A comma-separated list of rule targets to filter by. @@ -45491,7 +47099,7 @@ paths: application/json: schema: type: array - items: &310 + items: &314 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -45526,7 +47134,7 @@ paths: source: type: string description: The name of the source - enforcement: &286 + enforcement: &290 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -45539,7 +47147,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &287 + items: &291 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -45610,7 +47218,7 @@ paths: description: The html URL of the ruleset conditions: anyOf: - - &284 + - &288 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -45634,7 +47242,7 @@ paths: match. items: type: string - - &288 + - &292 title: Organization ruleset conditions type: object description: |- @@ -45648,7 +47256,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *284 + - *288 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -45682,7 +47290,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *284 + - *288 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -45704,7 +47312,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *284 + - *288 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -45717,7 +47325,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &285 + items: &289 title: Repository ruleset property targeting definition type: object @@ -45750,7 +47358,7 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *285 + items: *289 required: - repository_property type: @@ -45758,12 +47366,12 @@ paths: - object rules: type: array - items: &591 + items: &595 title: Repository Rule type: object description: A repository rule. oneOf: - - &289 + - &293 title: creation description: Only allow users with bypass permission to create matching refs. @@ -45775,7 +47383,7 @@ paths: type: string enum: - creation - - &290 + - &294 title: update description: Only allow users with bypass permission to update matching refs. @@ -45796,7 +47404,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &291 + - &295 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -45808,7 +47416,7 @@ paths: type: string enum: - deletion - - &292 + - &296 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -45820,7 +47428,7 @@ paths: type: string enum: - required_linear_history - - &589 + - &593 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -45898,7 +47506,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &293 + - &297 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -45922,7 +47530,7 @@ paths: type: string required: - required_deployment_environments - - &294 + - &298 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -45934,7 +47542,7 @@ paths: type: string enum: - required_signatures - - &295 + - &299 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -46040,7 +47648,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &296 + - &300 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -46088,7 +47696,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &297 + - &301 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -46100,7 +47708,7 @@ paths: type: string enum: - non_fast_forward - - &298 + - &302 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -46137,7 +47745,7 @@ paths: required: - operator - pattern - - &299 + - &303 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -46174,7 +47782,7 @@ paths: required: - operator - pattern - - &300 + - &304 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -46211,7 +47819,7 @@ paths: required: - operator - pattern - - &301 + - &305 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -46248,7 +47856,7 @@ paths: required: - operator - pattern - - &302 + - &306 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -46285,7 +47893,7 @@ paths: required: - operator - pattern - - &303 + - &307 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -46310,7 +47918,7 @@ paths: type: string required: - restricted_file_paths - - &304 + - &308 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -46334,7 +47942,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &305 + - &309 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -46357,7 +47965,7 @@ paths: type: string required: - restricted_file_extensions - - &306 + - &310 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -46382,7 +47990,7 @@ paths: maximum: 100 required: - max_file_size - - &307 + - &311 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -46432,7 +48040,7 @@ paths: - repository_id required: - workflows - - &308 + - &312 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -46493,7 +48101,7 @@ paths: - tool required: - code_scanning_tools - - &309 + - &313 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -46592,24 +48200,20 @@ paths: - push - repository default: branch - enforcement: *286 + enforcement: *290 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *287 - conditions: *288 + items: *291 + conditions: *292 rules: type: array description: An array of rules within the ruleset. - items: &312 + items: &316 title: Repository Rule type: object description: A repository rule. oneOf: - - *289 - - *290 - - *291 - - *292 - *293 - *294 - *295 @@ -46627,6 +48231,10 @@ paths: - *307 - *308 - *309 + - *310 + - *311 + - *312 + - *313 required: - name - enforcement @@ -46664,9 +48272,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *314 examples: - default: &311 + default: &315 value: id: 21 name: super cool ruleset @@ -46722,7 +48330,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *74 - - &592 + - &596 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -46737,7 +48345,7 @@ paths: in: query schema: type: string - - &593 + - &597 name: time_period description: |- The time period to filter by. @@ -46753,14 +48361,14 @@ paths: - week - month default: day - - &594 + - &598 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &595 + - &599 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -46780,7 +48388,7 @@ paths: description: Response content: application/json: - schema: &596 + schema: &600 title: Rule Suites description: Response type: array @@ -46836,7 +48444,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &597 + default: &601 value: - id: 21 actor_id: 12 @@ -46880,7 +48488,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *74 - - &598 + - &602 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -46896,7 +48504,7 @@ paths: description: Response content: application/json: - schema: &599 + schema: &603 title: Rule Suite description: Response type: object @@ -47003,7 +48611,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &600 + default: &604 value: id: 21 actor_id: 12 @@ -47076,9 +48684,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *314 examples: - default: *311 + default: *315 '404': *6 '500': *53 put: @@ -47122,16 +48730,16 @@ paths: - tag - push - repository - enforcement: *286 + enforcement: *290 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *287 - conditions: *288 + items: *291 + conditions: *292 rules: description: An array of rules within the ruleset. type: array - items: *312 + items: *316 examples: default: value: @@ -47166,9 +48774,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *314 examples: - default: *311 + default: *315 '404': *6 '422': *15 '500': *53 @@ -47226,7 +48834,7 @@ paths: application/json: schema: type: array - items: &313 + items: &317 title: Ruleset version type: object description: The historical version of a ruleset @@ -47250,7 +48858,7 @@ paths: type: string format: date-time examples: - default: &602 + default: &606 value: - version_id: 3 actor: @@ -47303,9 +48911,9 @@ paths: description: Response content: application/json: - schema: &603 + schema: &607 allOf: - - *313 + - *317 - type: object required: - state @@ -47375,7 +48983,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *74 - - &604 + - &608 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -47386,7 +48994,7 @@ paths: enum: - open - resolved - - &605 + - &609 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -47396,7 +49004,7 @@ paths: required: false schema: type: string - - &606 + - &610 name: exclude_secret_types in: query description: A comma-separated list of secret types to exclude from the results. @@ -47407,7 +49015,7 @@ paths: required: false schema: type: string - - &607 + - &611 name: exclude_providers in: query description: |- @@ -47418,7 +49026,7 @@ paths: required: false schema: type: string - - &608 + - &612 name: providers in: query description: |- @@ -47429,7 +49037,7 @@ paths: required: false schema: type: string - - &609 + - &613 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -47438,7 +49046,7 @@ paths: required: false schema: type: string - - &610 + - &614 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -47457,7 +49065,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &611 + - &615 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -47472,7 +49080,7 @@ paths: - *60 - *19 - *17 - - &612 + - &616 name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -47482,7 +49090,7 @@ paths: required: false schema: type: string - - &613 + - &617 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -47492,7 +49100,7 @@ paths: required: false schema: type: string - - &614 + - &618 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -47501,7 +49109,7 @@ paths: required: false schema: type: string - - &615 + - &619 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -47510,7 +49118,7 @@ paths: schema: type: boolean default: false - - &616 + - &620 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -47519,7 +49127,7 @@ paths: schema: type: boolean default: false - - &617 + - &621 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -47551,14 +49159,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &618 + state: &622 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &619 + resolution: &623 type: - string - 'null' @@ -47677,14 +49285,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &620 + - &624 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &622 + - &626 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -47748,7 +49356,7 @@ paths: - blob_url - commit_sha - commit_url - - &623 + - &627 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -47809,7 +49417,7 @@ paths: - page_url - commit_sha - commit_url - - &624 + - &628 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -47831,7 +49439,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &625 + - &629 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -47853,7 +49461,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &626 + - &630 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -47875,7 +49483,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &627 + - &631 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -47890,7 +49498,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &628 + - &632 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -47905,7 +49513,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &629 + - &633 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -47920,7 +49528,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &630 + - &634 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -47942,7 +49550,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &631 + - &635 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -47964,7 +49572,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &632 + - &636 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -47986,7 +49594,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &633 + - &637 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -48008,7 +49616,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &634 + - &638 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull @@ -48269,7 +49877,7 @@ paths: related to push protection. type: object properties: - pattern_config_version: &315 + pattern_config_version: &319 type: - string - 'null' @@ -48279,7 +49887,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &314 + items: &318 type: object properties: token_type: @@ -48348,7 +49956,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *314 + items: *318 examples: default: value: @@ -48405,7 +50013,7 @@ paths: schema: type: object properties: - pattern_config_version: *315 + pattern_config_version: *319 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -48431,7 +50039,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *315 + custom_pattern_version: *319 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -48529,7 +50137,7 @@ paths: application/json: schema: type: array - items: &638 + items: &642 description: A repository security advisory. type: object properties: @@ -48752,7 +50360,7 @@ paths: login: type: string description: The username of the user credited. - type: *316 + type: *320 credits_detailed: type: - array @@ -48763,7 +50371,7 @@ paths: type: object properties: user: *4 - type: *316 + type: *320 state: type: string description: The state of the user's acceptance of the @@ -48789,7 +50397,7 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *187 + items: *191 private_fork: readOnly: true description: A temporary private fork of the advisory's repository @@ -48826,7 +50434,7 @@ paths: - private_fork additionalProperties: false examples: - default: &639 + default: &643 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -49213,7 +50821,7 @@ paths: application/json: schema: type: array - items: *247 + items: *251 examples: default: value: @@ -49568,7 +51176,7 @@ paths: type: integer network_configurations: type: array - items: &317 + items: &321 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -49721,9 +51329,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *321 examples: - default: &318 + default: &322 value: id: 123456789ABCDEF name: My network configuration @@ -49752,7 +51360,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - *74 - - &319 + - &323 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -49764,9 +51372,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *321 examples: - default: *318 + default: *322 headers: Link: *66 x-github: @@ -49788,7 +51396,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - *74 - - *319 + - *323 requestBody: required: true content: @@ -49841,9 +51449,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *321 examples: - default: *318 + default: *322 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49863,7 +51471,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - *74 - - *319 + - *323 responses: '204': description: Response @@ -50008,13 +51616,13 @@ paths: application/json: schema: type: array - items: *320 + items: *324 examples: - default: *321 + default: *325 '500': *53 '403': *27 '404': *6 - '422': *322 + '422': *326 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50054,9 +51662,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - default: *248 + default: *252 headers: Link: *66 '403': *27 @@ -50142,7 +51750,7 @@ paths: description: Response content: application/json: - schema: &323 + schema: &327 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -50216,7 +51824,7 @@ paths: parent: anyOf: - type: 'null' - - *247 + - *251 members_count: type: integer examples: @@ -50541,7 +52149,7 @@ paths: - repos_count - organization examples: - default: &324 + default: &328 value: id: 1 node_id: MDQ6VGVhbTE= @@ -50618,9 +52226,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '404': *6 x-github: githubCloudOnly: false @@ -50705,16 +52313,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '201': description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '404': *6 '422': *15 '403': *27 @@ -50744,7 +52352,7 @@ paths: responses: '204': description: Response - '422': &325 + '422': &329 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -50778,12 +52386,12 @@ paths: application/json: schema: type: array - items: *226 + items: *230 examples: - default: *227 + default: *231 headers: Link: *66 - '422': *325 + '422': *329 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50865,7 +52473,7 @@ paths: description: Response content: application/json: - schema: &326 + schema: &330 title: Team Membership description: Team Membership type: object @@ -50893,7 +52501,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &654 + response-if-user-is-a-team-maintainer: &658 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -50956,9 +52564,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *330 examples: - response-if-users-membership-with-team-is-now-pending: &655 + response-if-users-membership-with-team-is-now-pending: &659 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -51034,7 +52642,7 @@ paths: type: array items: *153 examples: - default: *262 + default: *266 headers: Link: *66 x-github: @@ -51065,14 +52673,14 @@ paths: parameters: - *74 - *76 - - *327 - - *328 + - *331 + - *332 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &656 + schema: &660 title: Team Repository description: A team's access to a repository. type: object @@ -51707,8 +53315,8 @@ paths: parameters: - *74 - *76 - - *327 - - *328 + - *331 + - *332 requestBody: required: false content: @@ -51755,8 +53363,8 @@ paths: parameters: - *74 - *76 - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -51791,9 +53399,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - response-if-child-teams-exist: &657 + response-if-child-teams-exist: &661 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -51947,7 +53555,7 @@ paths: resources: type: object properties: - core: &329 + core: &333 title: Rate Limit type: object properties: @@ -51964,17 +53572,17 @@ paths: - remaining - reset - used - graphql: *329 - search: *329 - code_search: *329 - source_import: *329 - integration_manifest: *329 - code_scanning_upload: *329 - actions_runner_registration: *329 - scim: *329 - dependency_snapshots: *329 - dependency_sbom: *329 - code_scanning_autofix: *329 + graphql: *333 + search: *333 + code_search: *333 + source_import: *333 + integration_manifest: *333 + code_scanning_upload: *333 + actions_runner_registration: *333 + scim: *333 + dependency_snapshots: *333 + dependency_sbom: *333 + code_scanning_autofix: *333 required: - core - search @@ -52076,14 +53684,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *330 + schema: *334 examples: default-response: summary: Default response @@ -52587,7 +54195,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *331 + '301': *335 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52605,8 +54213,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: false content: @@ -52905,10 +54513,10 @@ paths: description: Response content: application/json: - schema: *330 + schema: *334 examples: - default: *332 - '307': &333 + default: *336 + '307': &337 description: Temporary Redirect content: application/json: @@ -52937,8 +54545,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -52960,7 +54568,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *333 + '307': *337 '404': *6 '409': *52 x-github: @@ -52984,11 +54592,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 - - &366 + - &370 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -53011,7 +54619,7 @@ paths: type: integer artifacts: type: array - items: &334 + items: &338 title: Artifact description: An artifact type: object @@ -53106,7 +54714,7 @@ paths: - expires_at - updated_at examples: - default: &367 + default: &371 value: total_count: 2 artifacts: @@ -53167,9 +54775,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *327 - - *328 - - &335 + - *331 + - *332 + - &339 name: artifact_id description: The unique identifier of the artifact. in: path @@ -53181,7 +54789,7 @@ paths: description: Response content: application/json: - schema: *334 + schema: *338 examples: default: value: @@ -53219,9 +54827,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *327 - - *328 - - *335 + - *331 + - *332 + - *339 responses: '204': description: Response @@ -53245,9 +54853,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *327 - - *328 - - *335 + - *331 + - *332 + - *339 - name: archive_format in: path required: true @@ -53257,11 +54865,11 @@ paths: '302': description: Response headers: - Location: &484 + Location: &488 example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': &525 + '410': &529 description: Gone content: application/json: @@ -53286,14 +54894,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: &336 + schema: &340 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -53327,13 +54935,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: application/json: - schema: *336 + schema: *340 examples: selected_actions: *40 responses: @@ -53362,14 +54970,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: &337 + schema: &341 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -53403,13 +55011,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: application/json: - schema: *337 + schema: *341 examples: selected_actions: *42 responses: @@ -53440,14 +55048,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *338 + schema: *342 examples: default: value: @@ -53473,11 +55081,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 - - &339 + - &343 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -53511,7 +55119,7 @@ paths: description: Response content: application/json: - schema: &340 + schema: &344 title: Repository actions caches description: Repository actions caches type: object @@ -53561,7 +55169,7 @@ paths: - total_count - actions_caches examples: - default: &341 + default: &345 value: total_count: 1 actions_caches: @@ -53593,23 +55201,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *327 - - *328 + - *331 + - *332 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *339 + - *343 responses: '200': description: Response content: application/json: - schema: *340 + schema: *344 examples: - default: *341 + default: *345 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53629,8 +55237,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *327 - - *328 + - *331 + - *332 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -53661,9 +55269,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *327 - - *328 - - &342 + - *331 + - *332 + - &346 name: job_id description: The unique identifier of the job. in: path @@ -53675,7 +55283,7 @@ paths: description: Response content: application/json: - schema: &370 + schema: &374 title: Job description: Information of a job execution in a workflow run type: object @@ -54022,9 +55630,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *327 - - *328 - - *342 + - *331 + - *332 + - *346 responses: '302': description: Response @@ -54052,9 +55660,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *327 - - *328 - - *342 + - *331 + - *332 + - *346 requestBody: required: false content: @@ -54100,8 +55708,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Status response @@ -54122,6 +55730,15 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether the repository has opted in to the immutable + OIDC subject claim format. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. If not set at the + repository level, falls back to the organization-level setting. + type: boolean + sub_claim_prefix: + description: The current `sub` claim prefix for this repository. + type: string required: - use_default examples: @@ -54151,8 +55768,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -54174,6 +55791,11 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for this repository. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. + type: boolean examples: default: value: @@ -54215,8 +55837,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -54234,7 +55856,7 @@ paths: type: integer secrets: type: array - items: &372 + items: &376 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -54255,7 +55877,7 @@ paths: - created_at - updated_at examples: - default: &373 + default: &377 value: total_count: 2 secrets: @@ -54288,9 +55910,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *327 - - *328 - - *343 + - *331 + - *332 + - *347 - *19 responses: '200': @@ -54307,7 +55929,7 @@ paths: type: integer variables: type: array - items: &376 + items: &380 title: Actions Variable type: object properties: @@ -54341,7 +55963,7 @@ paths: - created_at - updated_at examples: - default: &377 + default: &381 value: total_count: 2 variables: @@ -54374,8 +55996,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -54384,11 +56006,11 @@ paths: schema: type: object properties: - enabled: &345 + enabled: &349 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *138 - selected_actions_url: *344 + selected_actions_url: *348 sha_pinning_required: *139 required: - enabled @@ -54417,8 +56039,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -54429,7 +56051,7 @@ paths: schema: type: object properties: - enabled: *345 + enabled: *349 allowed_actions: *138 sha_pinning_required: *139 required: @@ -54461,14 +56083,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: &346 + schema: &350 type: object properties: access_level: @@ -54485,7 +56107,7 @@ paths: required: - access_level examples: - default: &347 + default: &351 value: access_level: organization x-github: @@ -54509,15 +56131,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: application/json: - schema: *346 + schema: *350 examples: - default: *347 + default: *351 responses: '204': description: Response @@ -54541,14 +56163,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *348 + schema: *352 examples: default: value: @@ -54572,8 +56194,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Empty response for successful settings update @@ -54583,7 +56205,7 @@ paths: required: true content: application/json: - schema: *349 + schema: *353 examples: default: summary: Set retention days @@ -54607,8 +56229,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -54616,7 +56238,7 @@ paths: application/json: schema: *140 examples: - default: *350 + default: *354 '404': *6 x-github: enabledForGitHubApps: true @@ -54635,8 +56257,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -54670,14 +56292,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *351 + schema: *355 examples: default: *141 '403': *27 @@ -54699,13 +56321,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: application/json: - schema: *352 + schema: *356 examples: default: *141 responses: @@ -54731,8 +56353,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -54759,8 +56381,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -54792,14 +56414,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *353 + schema: *357 examples: default: *148 x-github: @@ -54822,8 +56444,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Success response @@ -54834,7 +56456,7 @@ paths: required: true content: application/json: - schema: *354 + schema: *358 examples: default: *148 x-github: @@ -54863,8 +56485,8 @@ paths: in: query schema: type: string - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -54908,8 +56530,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -54917,9 +56539,9 @@ paths: application/json: schema: type: array - items: *355 + items: *359 examples: - default: *356 + default: *360 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54941,8 +56563,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -54985,7 +56607,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *357 + '201': *361 '404': *6 '422': *7 '409': *52 @@ -55016,8 +56638,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '201': description: Response @@ -55025,7 +56647,7 @@ paths: application/json: schema: *157 examples: - default: *358 + default: *362 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55053,8 +56675,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '201': description: Response @@ -55062,7 +56684,7 @@ paths: application/json: schema: *157 examples: - default: *359 + default: *363 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55084,8 +56706,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *154 responses: '200': @@ -55094,7 +56716,7 @@ paths: application/json: schema: *155 examples: - default: *360 + default: *364 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55115,8 +56737,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *154 responses: '204': @@ -55143,8 +56765,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *154 responses: '200': *159 @@ -55169,8 +56791,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *154 requestBody: required: true @@ -55219,8 +56841,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *154 requestBody: required: true @@ -55270,11 +56892,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *154 responses: - '200': *361 + '200': *365 '404': *6 x-github: githubCloudOnly: false @@ -55301,10 +56923,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *154 - - *362 + - *366 responses: '200': *159 '404': *6 @@ -55332,9 +56954,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *327 - - *328 - - &380 + - *331 + - *332 + - &384 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -55342,7 +56964,7 @@ paths: required: false schema: type: string - - &381 + - &385 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -55350,7 +56972,7 @@ paths: required: false schema: type: string - - &382 + - &386 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -55359,7 +56981,7 @@ paths: required: false schema: type: string - - &383 + - &387 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -55386,7 +57008,7 @@ paths: - pending - *17 - *19 - - &384 + - &388 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -55395,7 +57017,7 @@ paths: schema: type: string format: date-time - - &363 + - &367 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -55404,13 +57026,13 @@ paths: schema: type: boolean default: false - - &385 + - &389 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &386 + - &390 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -55433,7 +57055,7 @@ paths: type: integer workflow_runs: type: array - items: &364 + items: &368 title: Workflow Run description: An invocation of a workflow type: object @@ -55611,7 +57233,7 @@ paths: head_commit: anyOf: - type: 'null' - - &408 + - &412 title: Simple Commit description: A commit. type: object @@ -55726,7 +57348,7 @@ paths: - workflow_url - pull_requests examples: - default: &387 + default: &391 value: total_count: 1 workflow_runs: @@ -55962,24 +57584,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *327 - - *328 - - &365 + - *331 + - *332 + - &369 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *363 + - *367 responses: '200': description: Response content: application/json: - schema: *364 + schema: *368 examples: - default: &368 + default: &372 value: id: 30433642 name: Build @@ -56220,9 +57842,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '204': description: Response @@ -56245,9 +57867,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '200': description: Response @@ -56375,9 +57997,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '201': description: Response @@ -56410,12 +58032,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 - *17 - *19 - - *366 + - *370 - *60 responses: '200': @@ -56432,9 +58054,9 @@ paths: type: integer artifacts: type: array - items: *334 + items: *338 examples: - default: *367 + default: *371 headers: Link: *66 x-github: @@ -56458,25 +58080,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *327 - - *328 - - *365 - - &369 + - *331 + - *332 + - *369 + - &373 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *363 + - *367 responses: '200': description: Response content: application/json: - schema: *364 + schema: *368 examples: - default: *368 + default: *372 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56499,10 +58121,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *327 - - *328 - - *365 + - *331 + - *332 - *369 + - *373 - *17 - *19 responses: @@ -56520,9 +58142,9 @@ paths: type: integer jobs: type: array - items: *370 + items: *374 examples: - default: &371 + default: &375 value: total_count: 1 jobs: @@ -56635,10 +58257,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *327 - - *328 - - *365 + - *331 + - *332 - *369 + - *373 responses: '302': description: Response @@ -56666,9 +58288,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '202': description: Response @@ -56701,9 +58323,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 requestBody: required: true content: @@ -56770,9 +58392,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '202': description: Response @@ -56805,9 +58427,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -56837,9 +58459,9 @@ paths: type: integer jobs: type: array - items: *370 + items: *374 examples: - default: *371 + default: *375 headers: Link: *66 x-github: @@ -56864,9 +58486,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '302': description: Response @@ -56893,9 +58515,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '204': description: Response @@ -56922,9 +58544,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '200': description: Response @@ -56993,7 +58615,7 @@ paths: items: type: object properties: - type: &491 + type: &495 type: string description: The type of reviewer. enum: @@ -57004,7 +58626,7 @@ paths: reviewer: anyOf: - *4 - - *187 + - *191 required: - environment - wait_timer @@ -57079,9 +58701,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 requestBody: required: true content: @@ -57131,7 +58753,7 @@ paths: application/json: schema: type: array - items: &486 + items: &490 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -57243,7 +58865,7 @@ paths: - created_at - updated_at examples: - default: &487 + default: &491 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -57299,9 +58921,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 requestBody: required: false content: @@ -57346,9 +58968,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 requestBody: required: false content: @@ -57402,9 +59024,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '200': description: Response @@ -57541,8 +59163,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -57560,9 +59182,9 @@ paths: type: integer secrets: type: array - items: *372 + items: *376 examples: - default: *373 + default: *377 headers: Link: *66 x-github: @@ -57587,16 +59209,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *374 + schema: *378 examples: - default: *375 + default: *379 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57618,17 +59240,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 responses: '200': description: Response content: application/json: - schema: *372 + schema: *376 examples: - default: &504 + default: &508 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -57654,8 +59276,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 requestBody: required: true @@ -57713,8 +59335,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 responses: '204': @@ -57740,9 +59362,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *327 - - *328 - - *343 + - *331 + - *332 + - *347 - *19 responses: '200': @@ -57759,9 +59381,9 @@ paths: type: integer variables: type: array - items: *376 + items: *380 examples: - default: *377 + default: *381 headers: Link: *66 x-github: @@ -57784,8 +59406,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -57837,17 +59459,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *327 - - *328 + - *331 + - *332 - *164 responses: '200': description: Response content: application/json: - schema: *376 + schema: *380 examples: - default: &505 + default: &509 value: name: USERNAME value: octocat @@ -57873,8 +59495,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *327 - - *328 + - *331 + - *332 - *164 requestBody: required: true @@ -57917,8 +59539,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *327 - - *328 + - *331 + - *332 - *164 responses: '204': @@ -57944,8 +59566,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -57963,7 +59585,7 @@ paths: type: integer workflows: type: array - items: &378 + items: &382 title: Workflow description: A GitHub Actions workflow type: object @@ -58081,9 +59703,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *327 - - *328 - - &379 + - *331 + - *332 + - &383 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -58098,7 +59720,7 @@ paths: description: Response content: application/json: - schema: *378 + schema: *382 examples: default: value: @@ -58131,9 +59753,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *327 - - *328 - - *379 + - *331 + - *332 + - *383 responses: '204': description: Response @@ -58158,13 +59780,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *327 - - *328 - - *379 + - *331 + - *332 + - *383 responses: '200': - description: Response including the workflow run ID and URLs when `return_run_details` - parameter is `true`. + description: Response including the workflow run ID and URLs. content: application/json: schema: @@ -58241,9 +59862,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *327 - - *328 - - *379 + - *331 + - *332 + - *383 responses: '204': description: Response @@ -58270,19 +59891,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *327 - - *328 - - *379 - - *380 - - *381 - - *382 + - *331 + - *332 - *383 - - *17 - - *19 - *384 - - *363 - *385 - *386 + - *387 + - *17 + - *19 + - *388 + - *367 + - *389 + - *390 responses: '200': description: Response @@ -58298,9 +59919,9 @@ paths: type: integer workflow_runs: type: array - items: *364 + items: *368 examples: - default: *387 + default: *391 headers: Link: *66 x-github: @@ -58332,9 +59953,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *327 - - *328 - - *379 + - *331 + - *332 + - *383 responses: '200': description: Response @@ -58395,8 +60016,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *327 - - *328 + - *331 + - *332 - *60 - *17 - *45 @@ -58564,8 +60185,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -58602,8 +60223,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *327 - - *328 + - *331 + - *332 - name: assignee in: path required: true @@ -58639,8 +60260,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#create-an-attestation parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -58750,8 +60371,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#list-attestations parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *45 - *46 @@ -58792,7 +60413,7 @@ paths: initiator: type: string examples: - default: *388 + default: *392 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58812,8 +60433,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -58821,7 +60442,7 @@ paths: application/json: schema: type: array - items: &389 + items: &393 title: Autolink reference description: An autolink reference. type: object @@ -58880,8 +60501,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -58920,9 +60541,9 @@ paths: description: response content: application/json: - schema: *389 + schema: *393 examples: - default: &390 + default: &394 value: id: 1 key_prefix: TICKET- @@ -58953,9 +60574,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *327 - - *328 - - &391 + - *331 + - *332 + - &395 name: autolink_id description: The unique identifier of the autolink. in: path @@ -58967,9 +60588,9 @@ paths: description: Response content: application/json: - schema: *389 + schema: *393 examples: - default: *390 + default: *394 '404': *6 x-github: githubCloudOnly: false @@ -58989,9 +60610,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *327 - - *328 - - *391 + - *331 + - *332 + - *395 responses: '204': description: Response @@ -59015,8 +60636,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response if Dependabot is enabled @@ -59066,8 +60687,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -59088,8 +60709,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -59109,8 +60730,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *327 - - *328 + - *331 + - *332 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -59148,7 +60769,7 @@ paths: - url protected: type: boolean - protection: &393 + protection: &397 title: Branch Protection description: Branch Protection type: object @@ -59191,7 +60812,7 @@ paths: required: - contexts - checks - enforce_admins: &396 + enforce_admins: &400 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -59208,7 +60829,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &398 + required_pull_request_reviews: &402 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -59230,7 +60851,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *187 + items: *191 apps: description: The list of apps with review dismissal access. @@ -59262,7 +60883,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *187 + items: *191 apps: description: The list of apps allowed to bypass pull request requirements. @@ -59292,7 +60913,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &395 + restrictions: &399 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -59355,7 +60976,7 @@ paths: type: string teams: type: array - items: *187 + items: *191 apps: type: array items: @@ -59585,9 +61206,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *327 - - *328 - - &394 + - *331 + - *332 + - &398 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). @@ -59601,14 +61222,14 @@ paths: description: Response content: application/json: - schema: &404 + schema: &408 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &458 + commit: &462 title: Commit description: Commit type: object @@ -59647,7 +61268,7 @@ paths: author: anyOf: - type: 'null' - - &392 + - &396 title: Git User description: Metaproperties for Git author/committer information. @@ -59669,7 +61290,7 @@ paths: committer: anyOf: - type: 'null' - - *392 + - *396 message: type: string examples: @@ -59693,7 +61314,7 @@ paths: required: - sha - url - verification: &511 + verification: &515 title: Verification type: object properties: @@ -59773,7 +61394,7 @@ paths: type: integer files: type: array - items: &469 + items: &473 title: Diff Entry description: Diff Entry type: object @@ -59869,7 +61490,7 @@ paths: - self protected: type: boolean - protection: *393 + protection: *397 protection_url: type: string format: uri @@ -59978,7 +61599,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *331 + '301': *335 '404': *6 x-github: githubCloudOnly: false @@ -60000,15 +61621,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *393 + schema: *397 examples: default: value: @@ -60202,9 +61823,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -60464,7 +62085,7 @@ paths: url: type: string format: uri - required_status_checks: &401 + required_status_checks: &405 title: Status Check Policy description: Status Check Policy type: object @@ -60545,7 +62166,7 @@ paths: items: *4 teams: type: array - items: *187 + items: *191 apps: type: array items: *5 @@ -60563,7 +62184,7 @@ paths: items: *4 teams: type: array - items: *187 + items: *191 apps: type: array items: *5 @@ -60623,7 +62244,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *395 + restrictions: *399 required_conversation_resolution: type: object properties: @@ -60735,9 +62356,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '204': description: Response @@ -60762,17 +62383,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *396 + schema: *400 examples: - default: &397 + default: &401 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -60794,17 +62415,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *396 + schema: *400 examples: - default: *397 + default: *401 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60823,9 +62444,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '204': description: Response @@ -60850,17 +62471,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *398 + schema: *402 examples: - default: &399 + default: &403 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -60956,9 +62577,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: false content: @@ -61056,9 +62677,9 @@ paths: description: Response content: application/json: - schema: *398 + schema: *402 examples: - default: *399 + default: *403 '422': *15 x-github: githubCloudOnly: false @@ -61079,9 +62700,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '204': description: Response @@ -61108,17 +62729,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *396 + schema: *400 examples: - default: &400 + default: &404 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -61141,17 +62762,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *396 + schema: *400 examples: - default: *400 + default: *404 '404': *6 x-github: githubCloudOnly: false @@ -61171,9 +62792,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '204': description: Response @@ -61198,17 +62819,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *401 + schema: *405 examples: - default: &402 + default: &406 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -61234,9 +62855,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: false content: @@ -61288,9 +62909,9 @@ paths: description: Response content: application/json: - schema: *401 + schema: *405 examples: - default: *402 + default: *406 '404': *6 '422': *15 x-github: @@ -61312,9 +62933,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '204': description: Response @@ -61338,9 +62959,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response @@ -61374,9 +62995,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: false content: @@ -61443,9 +63064,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: false content: @@ -61509,9 +63130,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: content: application/json: @@ -61577,15 +63198,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *395 + schema: *399 examples: default: value: @@ -61676,9 +63297,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '204': description: Response @@ -61701,9 +63322,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response @@ -61713,7 +63334,7 @@ paths: type: array items: *5 examples: - default: &403 + default: &407 value: - id: 1 slug: octoapp @@ -61770,9 +63391,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -61806,7 +63427,7 @@ paths: type: array items: *5 examples: - default: *403 + default: *407 '422': *15 x-github: githubCloudOnly: false @@ -61827,9 +63448,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -61863,7 +63484,7 @@ paths: type: array items: *5 examples: - default: *403 + default: *407 '422': *15 x-github: githubCloudOnly: false @@ -61884,9 +63505,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -61920,7 +63541,7 @@ paths: type: array items: *5 examples: - default: *403 + default: *407 '422': *15 x-github: githubCloudOnly: false @@ -61942,9 +63563,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response @@ -61952,9 +63573,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - default: *248 + default: *252 '404': *6 x-github: githubCloudOnly: false @@ -61974,9 +63595,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: false content: @@ -62012,9 +63633,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - default: *248 + default: *252 '422': *15 x-github: githubCloudOnly: false @@ -62035,9 +63656,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: false content: @@ -62073,9 +63694,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - default: *248 + default: *252 '422': *15 x-github: githubCloudOnly: false @@ -62096,9 +63717,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: content: application/json: @@ -62133,9 +63754,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - default: *248 + default: *252 '422': *15 x-github: githubCloudOnly: false @@ -62157,9 +63778,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response @@ -62193,9 +63814,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -62253,9 +63874,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -62313,9 +63934,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -62375,9 +63996,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -62399,7 +64020,7 @@ paths: description: Response content: application/json: - schema: *404 + schema: *408 examples: default: value: @@ -62515,8 +64136,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -62795,7 +64416,7 @@ paths: description: Response content: application/json: - schema: &405 + schema: &409 title: CheckRun description: A check performed on the code of a given code change type: object @@ -62931,7 +64552,7 @@ paths: check. type: array items: *85 - deployment: &719 + deployment: &724 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -63218,9 +64839,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *327 - - *328 - - &406 + - *331 + - *332 + - &410 name: check_run_id description: The unique identifier of the check run. in: path @@ -63232,9 +64853,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *409 examples: - default: &407 + default: &411 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -63334,9 +64955,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *327 - - *328 - - *406 + - *331 + - *332 + - *410 requestBody: required: true content: @@ -63576,9 +65197,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *409 examples: - default: *407 + default: *411 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63598,9 +65219,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *327 - - *328 - - *406 + - *331 + - *332 + - *410 - *17 - *19 responses: @@ -63710,9 +65331,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *327 - - *328 - - *406 + - *331 + - *332 + - *410 responses: '201': description: Response @@ -63756,8 +65377,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -63779,7 +65400,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &409 + schema: &413 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -63877,7 +65498,7 @@ paths: - string - 'null' format: date-time - head_commit: *408 + head_commit: *412 latest_check_runs_count: type: integer check_runs_url: @@ -63905,7 +65526,7 @@ paths: - check_runs_url - pull_requests examples: - default: &410 + default: &414 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -64196,9 +65817,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *409 + schema: *413 examples: - default: *410 + default: *414 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64217,8 +65838,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -64527,9 +66148,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *327 - - *328 - - &411 + - *331 + - *332 + - &415 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -64541,9 +66162,9 @@ paths: description: Response content: application/json: - schema: *409 + schema: *413 examples: - default: *410 + default: *414 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64566,17 +66187,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *327 - - *328 - - *411 - - &464 + - *331 + - *332 + - *415 + - &468 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &465 + - &469 name: status description: Returns check runs with the specified `status`. in: query @@ -64615,9 +66236,9 @@ paths: type: integer check_runs: type: array - items: *405 + items: *409 examples: - default: &466 + default: &470 value: total_count: 1 check_runs: @@ -64719,9 +66340,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *327 - - *328 - - *411 + - *331 + - *332 + - *415 responses: '201': description: Response @@ -64754,21 +66375,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *327 - - *328 - - *412 - - *413 + - *331 + - *332 + - *416 + - *417 - *19 - *17 - - &430 + - &434 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *414 - - &431 + schema: *418 + - &435 name: pr description: The number of the pull request for the results you want to list. in: query @@ -64793,13 +66414,13 @@ paths: be returned. in: query required: false - schema: *415 + schema: *419 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *416 + schema: *420 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -64823,7 +66444,7 @@ paths: updated_at: *173 url: *174 html_url: *175 - instances_url: *417 + instances_url: *421 state: *180 fixed_at: *176 dismissed_by: @@ -64831,11 +66452,11 @@ paths: - type: 'null' - *4 dismissed_at: *177 - dismissed_reason: *418 - dismissed_comment: *419 - rule: *420 - tool: *421 - most_recent_instance: *422 + dismissed_reason: *422 + dismissed_comment: *423 + rule: *424 + tool: *425 + most_recent_instance: *426 dismissal_approved_by: anyOf: - type: 'null' @@ -64958,7 +66579,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &423 + '403': &427 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -64985,9 +66606,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *327 - - *328 - - &424 + - *331 + - *332 + - &428 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -65001,7 +66622,7 @@ paths: description: Response content: application/json: - schema: &425 + schema: &429 type: object properties: number: *171 @@ -65009,7 +66630,7 @@ paths: updated_at: *173 url: *174 html_url: *175 - instances_url: *417 + instances_url: *421 state: *180 fixed_at: *176 dismissed_by: @@ -65017,8 +66638,8 @@ paths: - type: 'null' - *4 dismissed_at: *177 - dismissed_reason: *418 - dismissed_comment: *419 + dismissed_reason: *422 + dismissed_comment: *423 rule: type: object properties: @@ -65080,8 +66701,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *421 - most_recent_instance: *422 + tool: *425 + most_recent_instance: *426 dismissal_approved_by: anyOf: - type: 'null' @@ -65177,7 +66798,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *423 + '403': *427 '404': *6 '503': *114 x-github: @@ -65197,9 +66818,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *327 - - *328 - - *424 + - *331 + - *332 + - *428 requestBody: required: true content: @@ -65214,8 +66835,8 @@ paths: enum: - open - dismissed - dismissed_reason: *418 - dismissed_comment: *419 + dismissed_reason: *422 + dismissed_comment: *423 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -65243,7 +66864,7 @@ paths: description: Response content: application/json: - schema: *425 + schema: *429 examples: default: value: @@ -65319,7 +66940,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &429 + '403': &433 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -65346,15 +66967,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *327 - - *328 - - *424 + - *331 + - *332 + - *428 responses: '200': description: Response content: application/json: - schema: &426 + schema: &430 type: object properties: status: @@ -65381,13 +67002,13 @@ paths: - description - started_at examples: - default: &427 + default: &431 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &428 + '400': &432 description: Bad Request content: application/json: @@ -65398,7 +67019,7 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *423 + '403': *427 '404': *6 '503': *114 x-github: @@ -65423,29 +67044,29 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *327 - - *328 - - *424 + - *331 + - *332 + - *428 responses: '200': description: OK content: application/json: - schema: *426 + schema: *430 examples: - default: *427 + default: *431 '202': description: Accepted content: application/json: - schema: *426 + schema: *430 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *428 + '400': *432 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -65477,9 +67098,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *327 - - *328 - - *424 + - *331 + - *332 + - *428 requestBody: required: false content: @@ -65525,8 +67146,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *428 - '403': *429 + '400': *432 + '403': *433 '404': *6 '422': description: Unprocessable Entity @@ -65550,13 +67171,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *327 - - *328 - - *424 + - *331 + - *332 + - *428 - *19 - *17 - - *430 - - *431 + - *434 + - *435 responses: '200': description: Response @@ -65567,10 +67188,10 @@ paths: items: type: object properties: - ref: *414 - analysis_key: *432 - environment: *433 - category: *434 + ref: *418 + analysis_key: *436 + environment: *437 + category: *438 state: type: - string @@ -65587,7 +67208,7 @@ paths: properties: text: type: string - location: *435 + location: *439 html_url: type: string classifications: @@ -65595,7 +67216,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: *436 + items: *440 examples: default: value: @@ -65632,7 +67253,7 @@ paths: end_column: 50 classifications: - source - '403': *423 + '403': *427 '404': *6 '503': *114 x-github: @@ -65666,25 +67287,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *327 - - *328 - - *412 - - *413 + - *331 + - *332 + - *416 + - *417 - *19 - *17 - - *431 + - *435 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *414 + schema: *418 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &437 + schema: &441 type: string description: An identifier for the upload. examples: @@ -65706,23 +67327,23 @@ paths: application/json: schema: type: array - items: &438 + items: &442 type: object properties: - ref: *414 - commit_sha: &446 + ref: *418 + commit_sha: &450 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *432 + analysis_key: *436 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *434 + category: *438 error: type: string examples: @@ -65747,8 +67368,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *437 - tool: *421 + sarif_id: *441 + tool: *425 deletable: type: boolean warning: @@ -65810,7 +67431,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *423 + '403': *427 '404': *6 '503': *114 x-github: @@ -65846,8 +67467,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -65860,7 +67481,7 @@ paths: description: Response content: application/json: - schema: *438 + schema: *442 examples: response: summary: application/json response @@ -65914,7 +67535,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *423 + '403': *427 '404': *6 '422': description: Response if analysis could not be processed @@ -66001,8 +67622,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -66058,7 +67679,7 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *429 + '403': *433 '404': *6 '503': *114 x-github: @@ -66080,8 +67701,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -66089,7 +67710,7 @@ paths: application/json: schema: type: array - items: &439 + items: &443 title: CodeQL Database description: A CodeQL database. type: object @@ -66201,7 +67822,7 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *423 + '403': *427 '404': *6 '503': *114 x-github: @@ -66230,8 +67851,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - name: language in: path description: The language of the CodeQL database. @@ -66243,7 +67864,7 @@ paths: description: Response content: application/json: - schema: *439 + schema: *443 examples: default: value: @@ -66275,9 +67896,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &473 + '302': &477 description: Found - '403': *423 + '403': *427 '404': *6 '503': *114 x-github: @@ -66299,8 +67920,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *327 - - *328 + - *331 + - *332 - name: language in: path description: The language of the CodeQL database. @@ -66310,7 +67931,7 @@ paths: responses: '204': description: Response - '403': *429 + '403': *433 '404': *6 '503': *114 x-github: @@ -66338,8 +67959,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -66348,7 +67969,7 @@ paths: type: object additionalProperties: false properties: - language: &440 + language: &444 type: string description: The language targeted by the CodeQL query enum: @@ -66428,7 +68049,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &444 + schema: &448 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -66438,7 +68059,7 @@ paths: description: The ID of the variant analysis. controller_repo: *65 actor: *4 - query_language: *440 + query_language: *444 query_pack_url: type: string description: The download url for the query pack. @@ -66486,7 +68107,7 @@ paths: items: type: object properties: - repository: &441 + repository: &445 title: Repository Identifier description: Repository Identifier type: object @@ -66528,7 +68149,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &445 + analysis_status: &449 type: string description: The new status of the CodeQL variant analysis repository task. @@ -66560,7 +68181,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &442 + access_mismatch_repos: &446 type: object properties: repository_count: @@ -66575,7 +68196,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *441 + items: *445 required: - repository_count - repositories @@ -66598,8 +68219,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *442 - over_limit_repos: *442 + no_codeql_db_repos: *446 + over_limit_repos: *446 required: - access_mismatch_repos - not_found_repos @@ -66615,7 +68236,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &443 + value: &447 summary: Default response value: id: 1 @@ -66761,10 +68382,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *443 + value: *447 repository_lists: summary: Response for a successful variant analysis submission - value: *443 + value: *447 '404': *6 '422': description: Unable to process variant analysis submission @@ -66792,8 +68413,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *327 - - *328 + - *331 + - *332 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -66805,9 +68426,9 @@ paths: description: Response content: application/json: - schema: *444 + schema: *448 examples: - default: *443 + default: *447 '404': *6 '503': *114 x-github: @@ -66830,7 +68451,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *327 + - *331 - name: repo in: path description: The name of the controller repository. @@ -66865,7 +68486,7 @@ paths: type: object properties: repository: *65 - analysis_status: *445 + analysis_status: *449 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -66990,8 +68611,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -67082,7 +68703,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *423 + '403': *427 '404': *6 '503': *114 x-github: @@ -67103,8 +68724,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -67198,7 +68819,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *429 + '403': *433 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -67269,8 +68890,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -67278,7 +68899,7 @@ paths: schema: type: object properties: - commit_sha: *446 + commit_sha: *450 ref: type: string description: |- @@ -67338,7 +68959,7 @@ paths: schema: type: object properties: - id: *437 + id: *441 url: type: string description: The REST API URL for checking the status of the upload. @@ -67352,7 +68973,7 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *429 + '403': *433 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -67375,8 +68996,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *327 - - *328 + - *331 + - *332 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -67424,7 +69045,7 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *423 + '403': *427 '404': description: Not Found if the sarif id does not match any upload '503': *114 @@ -67449,8 +69070,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -67531,8 +69152,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *327 - - *328 + - *331 + - *332 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -67660,8 +69281,8 @@ paths: parameters: - *17 - *19 - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -67677,7 +69298,7 @@ paths: type: integer codespaces: type: array - items: *237 + items: *241 examples: default: value: @@ -67975,8 +69596,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -68040,17 +69661,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '400': *14 '401': *23 '403': *27 @@ -68079,8 +69700,8 @@ paths: parameters: - *17 - *19 - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -68144,8 +69765,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -68182,9 +69803,9 @@ paths: type: integer machines: type: array - items: *448 + items: *452 examples: - default: &662 + default: &666 value: total_count: 2 machines: @@ -68224,8 +69845,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *327 - - *328 + - *331 + - *332 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -68312,8 +69933,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *327 - - *328 + - *331 + - *332 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -68382,8 +70003,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -68401,7 +70022,7 @@ paths: type: integer secrets: type: array - items: &452 + items: &456 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -68422,7 +70043,7 @@ paths: - created_at - updated_at examples: - default: *449 + default: *453 headers: Link: *66 x-github: @@ -68445,16 +70066,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *450 + schema: *454 examples: - default: *451 + default: *455 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -68474,17 +70095,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 responses: '200': description: Response content: application/json: - schema: *452 + schema: *456 examples: - default: *453 + default: *457 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68504,8 +70125,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 requestBody: required: true @@ -68558,8 +70179,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 responses: '204': @@ -68588,8 +70209,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *327 - - *328 + - *331 + - *332 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -68627,7 +70248,7 @@ paths: application/json: schema: type: array - items: &454 + items: &458 title: Collaborator description: Collaborator type: object @@ -68820,8 +70441,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *327 - - *328 + - *331 + - *332 - *70 responses: '204': @@ -68868,8 +70489,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *327 - - *328 + - *331 + - *332 - *70 requestBody: required: false @@ -68896,7 +70517,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &524 + schema: &528 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -69124,8 +70745,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *327 - - *328 + - *331 + - *332 - *70 responses: '204': @@ -69157,8 +70778,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *327 - - *328 + - *331 + - *332 - *70 responses: '200': @@ -69179,7 +70800,7 @@ paths: user: anyOf: - type: 'null' - - *454 + - *458 required: - permission - role_name @@ -69233,8 +70854,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -69244,7 +70865,7 @@ paths: application/json: schema: type: array - items: &455 + items: &459 title: Commit Comment description: Commit Comment type: object @@ -69302,7 +70923,7 @@ paths: - created_at - updated_at examples: - default: &460 + default: &464 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -69361,17 +70982,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '200': description: Response content: application/json: - schema: *455 + schema: *459 examples: - default: &461 + default: &465 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -69428,8 +71049,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 requestBody: required: true @@ -69452,7 +71073,7 @@ paths: description: Response content: application/json: - schema: *455 + schema: *459 examples: default: value: @@ -69503,8 +71124,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '204': @@ -69526,8 +71147,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -69554,7 +71175,7 @@ paths: application/json: schema: type: array - items: &456 + items: &460 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -69598,7 +71219,7 @@ paths: - content - created_at examples: - default: &527 + default: &531 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -69643,8 +71264,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 requestBody: required: true @@ -69677,9 +71298,9 @@ paths: description: Reaction exists content: application/json: - schema: *456 + schema: *460 examples: - default: &457 + default: &461 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -69708,9 +71329,9 @@ paths: description: Reaction created content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '422': *15 x-github: githubCloudOnly: false @@ -69732,10 +71353,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *327 - - *328 + - *331 + - *332 - *96 - - &528 + - &532 name: reaction_id description: The unique identifier of the reaction. in: path @@ -69790,8 +71411,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *327 - - *328 + - *331 + - *332 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -69847,9 +71468,9 @@ paths: application/json: schema: type: array - items: *458 + items: *462 examples: - default: &575 + default: &579 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -69943,9 +71564,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *327 - - *328 - - &459 + - *331 + - *332 + - &463 name: commit_sha description: The SHA of the commit. in: path @@ -70017,9 +71638,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *327 - - *328 - - *459 + - *331 + - *332 + - *463 - *17 - *19 responses: @@ -70029,9 +71650,9 @@ paths: application/json: schema: type: array - items: *455 + items: *459 examples: - default: *460 + default: *464 headers: Link: *66 x-github: @@ -70059,9 +71680,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *327 - - *328 - - *459 + - *331 + - *332 + - *463 requestBody: required: true content: @@ -70096,9 +71717,9 @@ paths: description: Response content: application/json: - schema: *455 + schema: *459 examples: - default: *461 + default: *465 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -70126,9 +71747,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *327 - - *328 - - *459 + - *331 + - *332 + - *463 - *17 - *19 responses: @@ -70138,9 +71759,9 @@ paths: application/json: schema: type: array - items: *462 + items: *466 examples: - default: &567 + default: &571 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -70677,11 +72298,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *327 - - *328 + - *331 + - *332 - *19 - *17 - - &463 + - &467 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -70696,9 +72317,9 @@ paths: description: Response content: application/json: - schema: *458 + schema: *462 examples: - default: &555 + default: &559 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -70786,7 +72407,7 @@ paths: schema: type: string examples: - default: &470 + default: &474 value: | diff --git a/testfile b/testfile index 9bdeaeb..912c7ef 100644 @@ -70799,7 +72420,7 @@ paths: schema: type: string examples: - default: &471 + default: &475 value: | From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001 From: Mona Lisa <87831417+monalisa@users.noreply.github.com> @@ -70852,11 +72473,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *327 - - *328 - - *463 - - *464 - - *465 + - *331 + - *332 + - *467 + - *468 + - *469 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -70890,9 +72511,9 @@ paths: type: integer check_runs: type: array - items: *405 + items: *409 examples: - default: *466 + default: *470 headers: Link: *66 x-github: @@ -70917,9 +72538,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *327 - - *328 - - *463 + - *331 + - *332 + - *467 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -70927,7 +72548,7 @@ paths: schema: type: integer example: 1 - - *464 + - *468 - *17 - *19 responses: @@ -70945,7 +72566,7 @@ paths: type: integer check_suites: type: array - items: *409 + items: *413 examples: default: value: @@ -71145,9 +72766,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *327 - - *328 - - *463 + - *331 + - *332 + - *467 - *17 - *19 responses: @@ -71349,9 +72970,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *327 - - *328 - - *463 + - *331 + - *332 + - *467 - *17 - *19 responses: @@ -71361,7 +72982,7 @@ paths: application/json: schema: type: array - items: &643 + items: &647 title: Status description: The status of a commit. type: object @@ -71442,7 +73063,7 @@ paths: site_admin: false headers: Link: *66 - '301': *331 + '301': *335 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71470,8 +73091,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -71504,11 +73125,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *467 + - *471 code_of_conduct_file: anyOf: - type: 'null' - - &468 + - &472 title: Community Health File type: object properties: @@ -71528,19 +73149,19 @@ paths: contributing: anyOf: - type: 'null' - - *468 + - *472 readme: anyOf: - type: 'null' - - *468 + - *472 issue_template: anyOf: - type: 'null' - - *468 + - *472 pull_request_template: anyOf: - type: 'null' - - *468 + - *472 required: - code_of_conduct - code_of_conduct_file @@ -71669,8 +73290,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *327 - - *328 + - *331 + - *332 - *19 - *17 - name: basehead @@ -71718,8 +73339,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *458 - merge_base_commit: *458 + base_commit: *462 + merge_base_commit: *462 status: type: string enum: @@ -71743,10 +73364,10 @@ paths: - 6 commits: type: array - items: *458 + items: *462 files: type: array - items: *469 + items: *473 required: - url - html_url @@ -71992,12 +73613,12 @@ paths: schema: type: string examples: - default: *470 + default: *474 application/vnd.github.patch: schema: type: string examples: - default: *471 + default: *475 '404': *6 '500': *53 '503': *114 @@ -72042,8 +73663,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *327 - - *328 + - *331 + - *332 - name: path description: path parameter in: path @@ -72213,7 +73834,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &472 + response-if-content-is-a-file-github-object: &476 summary: Response if content is a file value: type: file @@ -72350,7 +73971,7 @@ paths: - size - type - url - - &580 + - &584 title: Content File description: Content File type: object @@ -72568,7 +74189,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *472 + response-if-content-is-a-file: *476 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -72637,7 +74258,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *473 + '302': *477 '304': *35 x-github: githubCloudOnly: false @@ -72660,8 +74281,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *327 - - *328 + - *331 + - *332 - name: path description: path parameter in: path @@ -72756,7 +74377,7 @@ paths: description: Response content: application/json: - schema: &474 + schema: &478 title: File Commit description: File Commit type: object @@ -72912,7 +74533,7 @@ paths: description: Response content: application/json: - schema: *474 + schema: *478 examples: example-for-creating-a-file: value: @@ -72966,7 +74587,7 @@ paths: schema: oneOf: - *3 - - &506 + - &510 description: Repository rule violation was detected type: object properties: @@ -72987,7 +74608,7 @@ paths: items: type: object properties: - placeholder_id: &635 + placeholder_id: &639 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -73019,8 +74640,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *327 - - *328 + - *331 + - *332 - name: path description: path parameter in: path @@ -73081,7 +74702,7 @@ paths: description: Response content: application/json: - schema: *474 + schema: *478 examples: default: value: @@ -73136,8 +74757,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *327 - - *328 + - *331 + - *332 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -73261,24 +74882,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *327 - - *328 - - *189 - - *190 - - *191 - - *192 + - *331 + - *332 - *193 + - *194 + - *195 + - *196 + - *197 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *194 - - *475 - - *195 - - *196 - - *197 + - *198 + - *479 + - *199 + - *200 + - *201 - *60 - *45 - *46 @@ -73290,7 +74911,7 @@ paths: application/json: schema: type: array - items: &479 + items: &483 type: object description: A Dependabot alert. properties: @@ -73341,7 +74962,7 @@ paths: - transitive - inconclusive - - security_advisory: *476 + security_advisory: *480 security_vulnerability: *64 url: *174 html_url: *175 @@ -73372,8 +74993,8 @@ paths: dismissal. maxLength: 280 fixed_at: *176 - auto_dismissed_at: *477 - dismissal_request: *478 + auto_dismissed_at: *481 + dismissal_request: *482 assignees: type: array description: The users assigned to this alert. @@ -73628,9 +75249,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *327 - - *328 - - &480 + - *331 + - *332 + - &484 name: alert_number in: path description: |- @@ -73645,7 +75266,7 @@ paths: description: Response content: application/json: - schema: *479 + schema: *483 examples: default: value: @@ -73777,9 +75398,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *327 - - *328 - - *480 + - *331 + - *332 + - *484 requestBody: required: true content: @@ -73835,7 +75456,7 @@ paths: description: Response content: application/json: - schema: *479 + schema: *483 examples: default: value: @@ -73965,8 +75586,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -73984,7 +75605,7 @@ paths: type: integer secrets: type: array - items: &483 + items: &487 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -74038,16 +75659,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *481 + schema: *485 examples: - default: *482 + default: *486 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74067,15 +75688,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 responses: '200': description: Response content: application/json: - schema: *483 + schema: *487 examples: default: value: @@ -74101,8 +75722,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 requestBody: required: true @@ -74155,8 +75776,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 responses: '204': @@ -74179,8 +75800,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *327 - - *328 + - *331 + - *332 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -74354,8 +75975,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -74614,8 +76235,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - name: sbom_uuid in: path required: true @@ -74626,7 +76247,7 @@ paths: '302': description: Redirects to a temporary download URL for the completed SBOM. headers: - Location: *484 + Location: *488 '202': description: SBOM is still being processed, no content is returned. '404': *6 @@ -74647,8 +76268,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '201': description: Response @@ -74686,8 +76307,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -74770,7 +76391,7 @@ paths: - version - url additionalProperties: false - metadata: &485 + metadata: &489 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -74809,7 +76430,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *485 + metadata: *489 resolved: type: object description: A collection of resolved package dependencies. @@ -74823,7 +76444,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *485 + metadata: *489 relationship: type: string description: A notation of whether a dependency is requested @@ -74956,8 +76577,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *327 - - *328 + - *331 + - *332 - name: sha description: The SHA recorded at creation time. in: query @@ -74998,9 +76619,9 @@ paths: application/json: schema: type: array - items: *486 + items: *490 examples: - default: *487 + default: *491 headers: Link: *66 x-github: @@ -75066,8 +76687,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -75149,7 +76770,7 @@ paths: description: Response content: application/json: - schema: *486 + schema: *490 examples: simple-example: summary: Simple example @@ -75222,9 +76843,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *327 - - *328 - - &488 + - *331 + - *332 + - &492 name: deployment_id description: deployment_id parameter in: path @@ -75236,7 +76857,7 @@ paths: description: Response content: application/json: - schema: *486 + schema: *490 examples: default: value: @@ -75301,9 +76922,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *327 - - *328 - - *488 + - *331 + - *332 + - *492 responses: '204': description: Response @@ -75325,9 +76946,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *327 - - *328 - - *488 + - *331 + - *332 + - *492 - *17 - *19 responses: @@ -75337,7 +76958,7 @@ paths: application/json: schema: type: array - items: &489 + items: &493 title: Deployment Status description: The status of a deployment. type: object @@ -75501,9 +77122,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *327 - - *328 - - *488 + - *331 + - *332 + - *492 requestBody: required: true content: @@ -75578,9 +77199,9 @@ paths: description: Response content: application/json: - schema: *489 + schema: *493 examples: - default: &490 + default: &494 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -75636,9 +77257,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *327 - - *328 - - *488 + - *331 + - *332 + - *492 - name: status_id in: path required: true @@ -75649,9 +77270,9 @@ paths: description: Response content: application/json: - schema: *489 + schema: *493 examples: - default: *490 + default: *494 '404': *6 x-github: githubCloudOnly: false @@ -75676,8 +77297,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -75734,8 +77355,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -75753,7 +77374,7 @@ paths: - 5 environments: type: array - items: &492 + items: &496 title: Environment description: Details of a deployment environment type: object @@ -75815,7 +77436,7 @@ paths: type: string examples: - wait_timer - wait_timer: &494 + wait_timer: &498 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -75857,11 +77478,11 @@ paths: items: type: object properties: - type: *491 + type: *495 reviewer: anyOf: - *4 - - *187 + - *191 required: - id - node_id @@ -75884,7 +77505,7 @@ paths: - id - node_id - type - deployment_branch_policy: &495 + deployment_branch_policy: &499 type: - object - 'null' @@ -76001,9 +77622,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *327 - - *328 - - &493 + - *331 + - *332 + - &497 name: environment_name in: path required: true @@ -76016,9 +77637,9 @@ paths: description: Response content: application/json: - schema: *492 + schema: *496 examples: - default: &496 + default: &500 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -76102,9 +77723,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 requestBody: required: false content: @@ -76114,7 +77735,7 @@ paths: - object - 'null' properties: - wait_timer: *494 + wait_timer: *498 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -76133,14 +77754,14 @@ paths: items: type: object properties: - type: *491 + type: *495 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *495 + deployment_branch_policy: *499 additionalProperties: false examples: default: @@ -76160,9 +77781,9 @@ paths: description: Response content: application/json: - schema: *492 + schema: *496 examples: - default: *496 + default: *500 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -76186,9 +77807,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 responses: '204': description: Default response @@ -76213,9 +77834,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 - *17 - *19 responses: @@ -76234,7 +77855,7 @@ paths: - 2 branch_policies: type: array - items: &497 + items: &501 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -76295,9 +77916,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 requestBody: required: true content: @@ -76345,9 +77966,9 @@ paths: description: Response content: application/json: - schema: *497 + schema: *501 examples: - example-wildcard: &498 + example-wildcard: &502 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -76389,10 +78010,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *327 - - *328 - - *493 - - &499 + - *331 + - *332 + - *497 + - &503 name: branch_policy_id in: path required: true @@ -76404,9 +78025,9 @@ paths: description: Response content: application/json: - schema: *497 + schema: *501 examples: - default: *498 + default: *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76425,10 +78046,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *327 - - *328 - - *493 - - *499 + - *331 + - *332 + - *497 + - *503 requestBody: required: true content: @@ -76457,9 +78078,9 @@ paths: description: Response content: application/json: - schema: *497 + schema: *501 examples: - default: *498 + default: *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76478,10 +78099,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *327 - - *328 - - *493 - - *499 + - *331 + - *332 + - *497 + - *503 responses: '204': description: Response @@ -76506,9 +78127,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *493 - - *328 - - *327 + - *497 + - *332 + - *331 responses: '200': description: List of deployment protection rules @@ -76525,7 +78146,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &500 + items: &504 title: Deployment protection rule description: Deployment protection rule type: object @@ -76547,7 +78168,7 @@ paths: for the environment. examples: - true - app: &501 + app: &505 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -76650,9 +78271,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *493 - - *328 - - *327 + - *497 + - *332 + - *331 requestBody: content: application/json: @@ -76673,9 +78294,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *500 + schema: *504 examples: - default: &502 + default: &506 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -76710,9 +78331,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *493 - - *328 - - *327 + - *497 + - *332 + - *331 - *19 - *17 responses: @@ -76732,7 +78353,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *501 + items: *505 examples: default: value: @@ -76767,10 +78388,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *327 - - *328 - - *493 - - &503 + - *331 + - *332 + - *497 + - &507 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -76782,9 +78403,9 @@ paths: description: Response content: application/json: - schema: *500 + schema: *504 examples: - default: *502 + default: *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76805,10 +78426,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *493 - - *328 - - *327 - - *503 + - *497 + - *332 + - *331 + - *507 responses: '204': description: Response @@ -76834,9 +78455,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 - *17 - *19 responses: @@ -76854,9 +78475,9 @@ paths: type: integer secrets: type: array - items: *372 + items: *376 examples: - default: *373 + default: *377 headers: Link: *66 x-github: @@ -76881,17 +78502,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 responses: '200': description: Response content: application/json: - schema: *374 + schema: *378 examples: - default: *375 + default: *379 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76913,18 +78534,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 - *161 responses: '200': description: Response content: application/json: - schema: *372 + schema: *376 examples: - default: *504 + default: *508 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76946,9 +78567,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 - *161 requestBody: required: true @@ -77006,9 +78627,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 - *161 responses: '204': @@ -77034,10 +78655,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *327 - - *328 - - *493 - - *343 + - *331 + - *332 + - *497 + - *347 - *19 responses: '200': @@ -77054,9 +78675,9 @@ paths: type: integer variables: type: array - items: *376 + items: *380 examples: - default: *377 + default: *381 headers: Link: *66 x-github: @@ -77079,9 +78700,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 requestBody: required: true content: @@ -77133,18 +78754,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 - *164 responses: '200': description: Response content: application/json: - schema: *376 + schema: *380 examples: - default: *505 + default: *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77165,10 +78786,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *327 - - *328 + - *331 + - *332 - *164 - - *493 + - *497 requestBody: required: true content: @@ -77210,10 +78831,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *327 - - *328 + - *331 + - *332 - *164 - - *493 + - *497 responses: '204': description: Response @@ -77235,8 +78856,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -77304,8 +78925,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *327 - - *328 + - *331 + - *332 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -77464,8 +79085,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: false content: @@ -77498,9 +79119,9 @@ paths: description: Response content: application/json: - schema: *330 + schema: *334 examples: - default: *332 + default: *336 '400': *14 '422': *15 '403': *27 @@ -77521,8 +79142,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -77582,7 +79203,7 @@ paths: schema: oneOf: - *122 - - *506 + - *510 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77607,8 +79228,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *327 - - *328 + - *331 + - *332 - name: file_sha in: path required: true @@ -77708,8 +79329,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -77818,7 +79439,7 @@ paths: description: Response content: application/json: - schema: &507 + schema: &511 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -78045,15 +79666,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *327 - - *328 - - *459 + - *331 + - *332 + - *463 responses: '200': description: Response content: application/json: - schema: *507 + schema: *511 examples: default: value: @@ -78109,9 +79730,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *327 - - *328 - - &508 + - *331 + - *332 + - &512 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -78128,7 +79749,7 @@ paths: application/json: schema: type: array - items: &509 + items: &513 title: Git Reference description: Git references within a repository type: object @@ -78204,17 +79825,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *327 - - *328 - - *508 + - *331 + - *332 + - *512 responses: '200': description: Response content: application/json: - schema: *509 + schema: *513 examples: - default: &510 + default: &514 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -78243,8 +79864,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -78273,9 +79894,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *513 examples: - default: *510 + default: *514 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -78301,9 +79922,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *327 - - *328 - - *508 + - *331 + - *332 + - *512 requestBody: required: true content: @@ -78332,9 +79953,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *513 examples: - default: *510 + default: *514 '422': *15 '409': *52 x-github: @@ -78352,9 +79973,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *327 - - *328 - - *508 + - *331 + - *332 + - *512 responses: '204': description: Response @@ -78409,8 +80030,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -78477,7 +80098,7 @@ paths: description: Response content: application/json: - schema: &512 + schema: &516 title: Git Tag description: Metadata for a Git tag type: object @@ -78533,7 +80154,7 @@ paths: - sha - type - url - verification: *511 + verification: *515 required: - sha - url @@ -78543,7 +80164,7 @@ paths: - tag - message examples: - default: &513 + default: &517 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -78616,8 +80237,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *327 - - *328 + - *331 + - *332 - name: tag_sha in: path required: true @@ -78628,9 +80249,9 @@ paths: description: Response content: application/json: - schema: *512 + schema: *516 examples: - default: *513 + default: *517 '404': *6 '409': *52 x-github: @@ -78654,8 +80275,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -78729,7 +80350,7 @@ paths: description: Response content: application/json: - schema: &514 + schema: &518 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -78831,8 +80452,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *327 - - *328 + - *331 + - *332 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -78855,7 +80476,7 @@ paths: description: Response content: application/json: - schema: *514 + schema: *518 examples: default-response: summary: Default response @@ -78914,8 +80535,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -78925,7 +80546,7 @@ paths: application/json: schema: type: array - items: &515 + items: &519 title: Webhook description: Webhooks for repositories. type: object @@ -78988,7 +80609,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &750 + last_response: &755 title: Hook Response type: object properties: @@ -79065,8 +80686,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: false content: @@ -79119,9 +80740,9 @@ paths: description: Response content: application/json: - schema: *515 + schema: *519 examples: - default: &516 + default: &520 value: type: Repository id: 12345678 @@ -79169,17 +80790,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 responses: '200': description: Response content: application/json: - schema: *515 + schema: *519 examples: - default: *516 + default: *520 '404': *6 x-github: githubCloudOnly: false @@ -79199,9 +80820,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 requestBody: required: true content: @@ -79246,9 +80867,9 @@ paths: description: Response content: application/json: - schema: *515 + schema: *519 examples: - default: *516 + default: *520 '422': *15 '404': *6 x-github: @@ -79269,9 +80890,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 responses: '204': description: Response @@ -79295,9 +80916,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 responses: '200': description: Response @@ -79324,9 +80945,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 requestBody: required: false content: @@ -79370,12 +80991,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 - *17 - - *206 - - *207 + - *210 + - *211 responses: '200': description: Response @@ -79383,9 +81004,9 @@ paths: application/json: schema: type: array - items: *208 + items: *212 examples: - default: *209 + default: *213 '400': *14 '422': *15 x-github: @@ -79404,18 +81025,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 - *16 responses: '200': description: Response content: application/json: - schema: *210 + schema: *214 examples: - default: *211 + default: *215 '400': *14 '422': *15 x-github: @@ -79434,9 +81055,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 - *16 responses: '202': *37 @@ -79459,9 +81080,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 responses: '204': description: Response @@ -79486,9 +81107,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 responses: '204': description: Response @@ -79511,8 +81132,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response if immutable releases are enabled @@ -79560,8 +81181,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': *59 '409': *52 @@ -79581,8 +81202,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': *59 '409': *52 @@ -79639,14 +81260,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: &517 + schema: &521 title: Import description: A repository import from an external source. type: object @@ -79753,7 +81374,7 @@ paths: - html_url - authors_url examples: - default: &520 + default: &524 value: vcs: subversion use_lfs: true @@ -79769,7 +81390,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &518 + '503': &522 description: Unavailable due to service under maintenance. content: application/json: @@ -79798,8 +81419,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -79847,7 +81468,7 @@ paths: description: Response content: application/json: - schema: *517 + schema: *521 examples: default: value: @@ -79872,7 +81493,7 @@ paths: type: string '422': *15 '404': *6 - '503': *518 + '503': *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79900,8 +81521,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: false content: @@ -79953,7 +81574,7 @@ paths: description: Response content: application/json: - schema: *517 + schema: *521 examples: example-1: summary: Example 1 @@ -80001,7 +81622,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *518 + '503': *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80024,12 +81645,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response - '503': *518 + '503': *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80055,9 +81676,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *327 - - *328 - - &684 + - *331 + - *332 + - &688 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -80071,7 +81692,7 @@ paths: application/json: schema: type: array - items: &519 + items: &523 title: Porter Author description: Porter Author type: object @@ -80125,7 +81746,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *518 + '503': *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80150,8 +81771,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *327 - - *328 + - *331 + - *332 - name: author_id in: path required: true @@ -80181,7 +81802,7 @@ paths: description: Response content: application/json: - schema: *519 + schema: *523 examples: default: value: @@ -80194,7 +81815,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *518 + '503': *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80218,8 +81839,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -80260,7 +81881,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *518 + '503': *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80288,8 +81909,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -80316,11 +81937,11 @@ paths: description: Response content: application/json: - schema: *517 + schema: *521 examples: - default: *520 + default: *524 '422': *15 - '503': *518 + '503': *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80343,8 +81964,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -80352,8 +81973,8 @@ paths: application/json: schema: *20 examples: - default: *521 - '301': *331 + default: *525 + '301': *335 '404': *6 x-github: githubCloudOnly: false @@ -80373,8 +81994,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -80382,12 +82003,12 @@ paths: application/json: schema: anyOf: - - *224 + - *228 - type: object properties: {} additionalProperties: false examples: - default: &523 + default: &527 value: limit: collaborators_only origin: repository @@ -80412,13 +82033,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: application/json: - schema: *522 + schema: *526 examples: default: summary: Example request body @@ -80430,9 +82051,9 @@ paths: description: Response content: application/json: - schema: *224 + schema: *228 examples: - default: *523 + default: *527 '409': description: Response x-github: @@ -80454,8 +82075,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -80478,8 +82099,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -80489,9 +82110,9 @@ paths: application/json: schema: type: array - items: *524 + items: *528 examples: - default: &676 + default: &680 value: - id: 1 repository: @@ -80622,9 +82243,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *327 - - *328 - - *228 + - *331 + - *332 + - *232 requestBody: required: false content: @@ -80653,7 +82274,7 @@ paths: description: Response content: application/json: - schema: *524 + schema: *528 examples: default: value: @@ -80784,9 +82405,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *327 - - *328 - - *228 + - *331 + - *332 + - *232 responses: '204': description: Response @@ -80817,8 +82438,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *327 - - *328 + - *331 + - *332 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -80866,7 +82487,7 @@ paths: required: false schema: type: string - - *235 + - *239 - name: sort description: What to sort results by. in: query @@ -80891,7 +82512,7 @@ paths: type: array items: *82 examples: - default: &533 + default: &537 value: - id: 1 node_id: MDU6SXNzdWUx @@ -81040,7 +82661,7 @@ paths: state_reason: completed headers: Link: *66 - '301': *331 + '301': *335 '422': *15 '404': *6 x-github: @@ -81069,8 +82690,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -81154,7 +82775,7 @@ paths: application/json: schema: *82 examples: - default: &530 + default: &534 value: id: 1 node_id: MDU6SXNzdWUx @@ -81292,7 +82913,7 @@ paths: '422': *15 '503': *114 '404': *6 - '410': *525 + '410': *529 x-github: triggersNotification: true githubCloudOnly: false @@ -81320,8 +82941,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *104 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -81344,7 +82965,7 @@ paths: type: array items: *83 examples: - default: &532 + default: &536 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -81402,8 +83023,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '200': @@ -81412,7 +83033,7 @@ paths: application/json: schema: *83 examples: - default: &526 + default: &530 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -81467,8 +83088,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 requestBody: required: true @@ -81493,7 +83114,7 @@ paths: application/json: schema: *83 examples: - default: *526 + default: *530 '422': *15 x-github: githubCloudOnly: false @@ -81511,8 +83132,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '204': @@ -81541,8 +83162,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#pin-an-issue-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '200': @@ -81605,7 +83226,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *525 + '410': *529 '422': *15 x-github: githubCloudOnly: false @@ -81622,8 +83243,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#unpin-an-issue-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '204': @@ -81631,7 +83252,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *525 + '410': *529 '503': *114 x-github: githubCloudOnly: false @@ -81649,8 +83270,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -81677,9 +83298,9 @@ paths: application/json: schema: type: array - items: *456 + items: *460 examples: - default: *527 + default: *531 headers: Link: *66 '404': *6 @@ -81700,8 +83321,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 requestBody: required: true @@ -81734,16 +83355,16 @@ paths: description: Reaction exists content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '201': description: Reaction created content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '422': *15 x-github: githubCloudOnly: false @@ -81765,10 +83386,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *327 - - *328 + - *331 + - *332 - *96 - - *528 + - *532 responses: '204': description: Response @@ -81788,8 +83409,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -81799,7 +83420,7 @@ paths: application/json: schema: type: array - items: &529 + items: &533 title: Issue Event description: Issue Event type: object @@ -81879,7 +83500,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *187 + requested_team: *191 dismissed_review: title: Issue Event Dismissed Review type: object @@ -82139,8 +83760,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *327 - - *328 + - *331 + - *332 - name: event_id in: path required: true @@ -82151,7 +83772,7 @@ paths: description: Response content: application/json: - schema: *529 + schema: *533 examples: default: value: @@ -82344,7 +83965,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *525 + '410': *529 '403': *27 x-github: githubCloudOnly: false @@ -82378,9 +83999,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *327 - - *328 - - &531 + - *331 + - *332 + - &535 name: issue_number description: The number that identifies the issue. in: path @@ -82396,7 +84017,7 @@ paths: examples: default: summary: Issue - value: *530 + value: *534 pinned_comment: summary: Issue with pinned comment value: @@ -82576,9 +84197,9 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 '304': *35 x-github: githubCloudOnly: false @@ -82603,9 +84224,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: false content: @@ -82740,13 +84361,13 @@ paths: application/json: schema: *82 examples: - default: *530 + default: *534 '422': *15 '503': *114 '403': *27 - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82764,9 +84385,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: false content: @@ -82794,7 +84415,7 @@ paths: application/json: schema: *82 examples: - default: *530 + default: *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82810,9 +84431,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: content: application/json: @@ -82839,7 +84460,7 @@ paths: application/json: schema: *82 examples: - default: *530 + default: *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82861,9 +84482,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - name: assignee in: path required: true @@ -82903,9 +84524,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *87 - *17 - *19 @@ -82918,11 +84539,11 @@ paths: type: array items: *83 examples: - default: *532 + default: *536 headers: Link: *66 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82951,9 +84572,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -82977,14 +84598,14 @@ paths: application/json: schema: *83 examples: - default: *526 + default: *530 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *525 + '410': *529 '422': *15 '404': *6 x-github: @@ -83012,9 +84633,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *17 - *19 responses: @@ -83026,12 +84647,12 @@ paths: type: array items: *82 examples: - default: *533 + default: *537 headers: Link: *66 - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83059,9 +84680,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -83085,15 +84706,15 @@ paths: application/json: schema: *82 examples: - default: *530 + default: *534 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *331 + '301': *335 '403': *27 - '410': *525 + '410': *529 '422': *15 '404': *6 x-github: @@ -83124,9 +84745,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -83140,13 +84761,13 @@ paths: application/json: schema: *82 examples: - default: *530 - '301': *331 + default: *534 + '301': *335 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *525 + '410': *529 x-github: triggersNotification: true githubCloudOnly: false @@ -83172,9 +84793,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *17 - *19 responses: @@ -83186,12 +84807,12 @@ paths: type: array items: *82 examples: - default: *533 + default: *537 headers: Link: *66 - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83208,9 +84829,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *17 - *19 responses: @@ -83224,7 +84845,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &537 + - &541 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -83273,7 +84894,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &538 + - &542 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -83401,7 +85022,7 @@ paths: - performed_via_github_app - assignee - assigner - - &539 + - &543 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -83447,7 +85068,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &540 + - &544 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -83493,7 +85114,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &541 + - &545 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -83542,7 +85163,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &542 + - &546 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -83571,7 +85192,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *187 + requested_team: *191 requested_reviewer: *4 required: - review_requester @@ -83584,7 +85205,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &543 + - &547 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -83613,7 +85234,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *187 + requested_team: *191 requested_reviewer: *4 required: - review_requester @@ -83626,7 +85247,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &544 + - &548 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -83682,7 +85303,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &545 + - &549 title: Locked Issue Event description: Locked Issue Event type: object @@ -83727,7 +85348,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &546 + - &550 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -83788,7 +85409,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &547 + - &551 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -83849,7 +85470,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &548 + - &552 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -83910,7 +85531,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &549 + - &553 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -84003,7 +85624,7 @@ paths: color: red headers: Link: *66 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84020,9 +85641,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#list-issue-field-values-for-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *17 - *19 responses: @@ -84032,9 +85653,9 @@ paths: application/json: schema: type: array - items: *534 + items: *538 examples: - default: &535 + default: &539 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -84058,9 +85679,9 @@ paths: value: '2025-12-25' headers: Link: *66 - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84089,9 +85710,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -84157,9 +85778,9 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *534 + items: *538 examples: - default: *535 + default: *539 '400': *14 '403': *27 '404': *6 @@ -84195,9 +85816,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -84264,9 +85885,9 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *534 + items: *538 examples: - default: *535 + default: *539 '400': *14 '403': *27 '404': *6 @@ -84297,10 +85918,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue parameters: - - *327 - - *328 - - *531 - - *231 + - *331 + - *332 + - *535 + - *235 responses: '204': description: Issue field value deleted successfully @@ -84325,9 +85946,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *17 - *19 responses: @@ -84339,7 +85960,7 @@ paths: type: array items: *81 examples: - default: &536 + default: &540 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -84357,9 +85978,9 @@ paths: default: false headers: Link: *66 - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84375,9 +85996,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: false content: @@ -84422,10 +86043,10 @@ paths: type: array items: *81 examples: - default: *536 - '301': *331 + default: *540 + '301': *335 '404': *6 - '410': *525 + '410': *529 '422': *15 x-github: githubCloudOnly: false @@ -84442,9 +86063,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: false content: @@ -84506,10 +86127,10 @@ paths: type: array items: *81 examples: - default: *536 - '301': *331 + default: *540 + '301': *335 '404': *6 - '410': *525 + '410': *529 '422': *15 x-github: githubCloudOnly: false @@ -84526,15 +86147,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 responses: '204': description: Response - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84553,9 +86174,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - name: name in: path required: true @@ -84579,9 +86200,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84601,9 +86222,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: false content: @@ -84632,7 +86253,7 @@ paths: '204': description: Response '403': *27 - '410': *525 + '410': *529 '404': *6 '422': *15 x-github: @@ -84650,9 +86271,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 responses: '204': description: Response @@ -84682,9 +86303,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 responses: '200': description: Response @@ -84692,10 +86313,10 @@ paths: application/json: schema: *82 examples: - default: *530 - '301': *331 + default: *534 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84712,9 +86333,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -84740,13 +86361,13 @@ paths: application/json: schema: type: array - items: *456 + items: *460 examples: - default: *527 + default: *531 headers: Link: *66 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84764,9 +86385,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -84798,16 +86419,16 @@ paths: description: Response content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '201': description: Response content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '422': *15 x-github: githubCloudOnly: false @@ -84829,10 +86450,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *327 - - *328 - - *531 - - *528 + - *331 + - *332 + - *535 + - *532 responses: '204': description: Response @@ -84861,9 +86482,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -84887,7 +86508,7 @@ paths: application/json: schema: *82 examples: - default: *530 + default: *534 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -84920,9 +86541,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *17 - *19 responses: @@ -84934,11 +86555,11 @@ paths: type: array items: *82 examples: - default: *533 + default: *537 headers: Link: *66 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84966,9 +86587,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -84997,14 +86618,14 @@ paths: application/json: schema: *82 examples: - default: *530 + default: *534 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *525 + '410': *529 '422': *15 '404': *6 x-github: @@ -85024,9 +86645,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -85059,7 +86680,7 @@ paths: application/json: schema: *82 examples: - default: *530 + default: *534 '403': *27 '404': *6 '422': *7 @@ -85081,9 +86702,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *17 - *19 responses: @@ -85098,10 +86719,6 @@ paths: description: Timeline Event type: object anyOf: - - *537 - - *538 - - *539 - - *540 - *541 - *542 - *543 @@ -85111,6 +86728,10 @@ paths: - *547 - *548 - *549 + - *550 + - *551 + - *552 + - *553 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -85167,7 +86788,7 @@ paths: pin: anyOf: - type: 'null' - - *550 + - *554 required: - event - actor @@ -85443,7 +87064,7 @@ paths: type: string comments: type: array - items: &569 + items: &573 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -85684,7 +87305,7 @@ paths: type: string comments: type: array - items: *455 + items: *459 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -85959,7 +87580,7 @@ paths: headers: Link: *66 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85976,8 +87597,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -85987,7 +87608,7 @@ paths: application/json: schema: type: array - items: &551 + items: &555 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -86055,8 +87676,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -86092,9 +87713,9 @@ paths: description: Response content: application/json: - schema: *551 + schema: *555 examples: - default: &552 + default: &556 value: id: 1 key: ssh-rsa AAA... @@ -86128,9 +87749,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *327 - - *328 - - &553 + - *331 + - *332 + - &557 name: key_id description: The unique identifier of the key. in: path @@ -86142,9 +87763,9 @@ paths: description: Response content: application/json: - schema: *551 + schema: *555 examples: - default: *552 + default: *556 '404': *6 x-github: githubCloudOnly: false @@ -86162,9 +87783,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *327 - - *328 - - *553 + - *331 + - *332 + - *557 responses: '204': description: Response @@ -86184,8 +87805,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -86197,7 +87818,7 @@ paths: type: array items: *81 examples: - default: *536 + default: *540 headers: Link: *66 '404': *6 @@ -86218,8 +87839,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -86257,7 +87878,7 @@ paths: application/json: schema: *81 examples: - default: &554 + default: &558 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -86289,8 +87910,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *327 - - *328 + - *331 + - *332 - name: name in: path required: true @@ -86303,7 +87924,7 @@ paths: application/json: schema: *81 examples: - default: *554 + default: *558 '404': *6 x-github: githubCloudOnly: false @@ -86320,8 +87941,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *327 - - *328 + - *331 + - *332 - name: name in: path required: true @@ -86386,8 +88007,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *327 - - *328 + - *331 + - *332 - name: name in: path required: true @@ -86413,8 +88034,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -86453,9 +88074,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *327 - - *328 - - *430 + - *331 + - *332 + - *434 responses: '200': description: Response @@ -86602,8 +88223,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -86668,8 +88289,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -86703,9 +88324,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *458 + schema: *462 examples: - default: *555 + default: *559 '204': description: Response when already merged '404': @@ -86730,8 +88351,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *327 - - *328 + - *331 + - *332 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -86772,7 +88393,7 @@ paths: application/json: schema: type: array - items: *268 + items: *272 examples: default: value: @@ -86828,8 +88449,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -86869,9 +88490,9 @@ paths: description: Response content: application/json: - schema: *268 + schema: *272 examples: - default: &556 + default: &560 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -86930,9 +88551,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *327 - - *328 - - &557 + - *331 + - *332 + - &561 name: milestone_number description: The number that identifies the milestone. in: path @@ -86944,9 +88565,9 @@ paths: description: Response content: application/json: - schema: *268 + schema: *272 examples: - default: *556 + default: *560 '404': *6 x-github: githubCloudOnly: false @@ -86963,9 +88584,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *327 - - *328 - - *557 + - *331 + - *332 + - *561 requestBody: required: false content: @@ -87003,9 +88624,9 @@ paths: description: Response content: application/json: - schema: *268 + schema: *272 examples: - default: *556 + default: *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87021,9 +88642,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *327 - - *328 - - *557 + - *331 + - *332 + - *561 responses: '204': description: Response @@ -87044,9 +88665,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *327 - - *328 - - *557 + - *331 + - *332 + - *561 - *17 - *19 responses: @@ -87058,7 +88679,7 @@ paths: type: array items: *81 examples: - default: *536 + default: *540 headers: Link: *66 x-github: @@ -87077,12 +88698,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *327 - - *328 - - *558 - - *559 + - *331 + - *332 + - *562 + - *563 - *87 - - *560 + - *564 - *17 - *19 responses: @@ -87094,7 +88715,7 @@ paths: type: array items: *107 examples: - default: *561 + default: *565 headers: Link: *66 x-github: @@ -87118,8 +88739,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: false content: @@ -87177,14 +88798,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: &562 + schema: &566 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -87328,7 +88949,7 @@ paths: - custom_404 - public examples: - default: &563 + default: &567 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -87369,8 +88990,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -87425,9 +89046,9 @@ paths: description: Response content: application/json: - schema: *562 + schema: *566 examples: - default: *563 + default: *567 '422': *15 '409': *52 x-github: @@ -87450,8 +89071,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -87551,8 +89172,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -87578,8 +89199,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -87589,7 +89210,7 @@ paths: application/json: schema: type: array - items: &564 + items: &568 title: Page Build description: Page Build type: object @@ -87681,8 +89302,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *327 - - *328 + - *331 + - *332 responses: '201': description: Response @@ -87729,16 +89350,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *564 + schema: *568 examples: - default: &565 + default: &569 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -87786,8 +89407,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *327 - - *328 + - *331 + - *332 - name: build_id in: path required: true @@ -87798,9 +89419,9 @@ paths: description: Response content: application/json: - schema: *564 + schema: *568 examples: - default: *565 + default: *569 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87820,8 +89441,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -87929,9 +89550,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *327 - - *328 - - &566 + - *331 + - *332 + - &570 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -87989,9 +89610,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *327 - - *328 - - *566 + - *331 + - *332 + - *570 responses: '204': *59 '404': *6 @@ -88018,8 +89639,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -88314,8 +89935,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Private vulnerability reporting status @@ -88352,8 +89973,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': *59 '422': *14 @@ -88374,8 +89995,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': *59 '422': *14 @@ -88397,8 +90018,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -88406,7 +90027,7 @@ paths: application/json: schema: type: array - items: *282 + items: *286 examples: default: value: @@ -88437,8 +90058,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -88450,7 +90071,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *282 + items: *286 required: - properties examples: @@ -88500,8 +90121,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *327 - - *328 + - *331 + - *332 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -88561,9 +90182,9 @@ paths: application/json: schema: type: array - items: *462 + items: *466 examples: - default: *567 + default: *571 headers: Link: *66 '304': *35 @@ -88595,8 +90216,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -88663,7 +90284,7 @@ paths: description: Response content: application/json: - schema: &571 + schema: &575 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -88792,7 +90413,7 @@ paths: milestone: anyOf: - type: 'null' - - *268 + - *272 active_lock_reason: type: - string @@ -88831,7 +90452,7 @@ paths: items: *4 requested_teams: type: array - items: *247 + items: *251 head: type: object properties: @@ -88869,14 +90490,14 @@ paths: _links: type: object properties: - comments: *269 - commits: *269 - statuses: *269 - html: *269 - issue: *269 - review_comments: *269 - review_comment: *269 - self: *269 + comments: *273 + commits: *273 + statuses: *273 + html: *273 + issue: *273 + review_comments: *273 + review_comment: *273 + self: *273 required: - comments - commits @@ -88887,7 +90508,7 @@ paths: - review_comment - self author_association: *79 - auto_merge: *568 + auto_merge: *572 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -88987,7 +90608,7 @@ paths: - merged_by - review_comments examples: - default: &572 + default: &576 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -89494,8 +91115,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - name: sort in: query required: false @@ -89524,9 +91145,9 @@ paths: application/json: schema: type: array - items: *569 + items: *573 examples: - default: &574 + default: &578 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -89603,17 +91224,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '200': description: Response content: application/json: - schema: *569 + schema: *573 examples: - default: &570 + default: &574 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -89688,8 +91309,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 + - *331 + - *332 - *96 requestBody: required: true @@ -89712,9 +91333,9 @@ paths: description: Response content: application/json: - schema: *569 + schema: *573 examples: - default: *570 + default: *574 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89730,8 +91351,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '204': @@ -89753,8 +91374,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -89781,9 +91402,9 @@ paths: application/json: schema: type: array - items: *456 + items: *460 examples: - default: *527 + default: *531 headers: Link: *66 '404': *6 @@ -89804,8 +91425,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 requestBody: required: true @@ -89838,16 +91459,16 @@ paths: description: Reaction exists content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '201': description: Reaction created content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '422': *15 x-github: githubCloudOnly: false @@ -89869,10 +91490,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *327 - - *328 + - *331 + - *332 - *96 - - *528 + - *532 responses: '204': description: Response @@ -89915,9 +91536,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *327 - - *328 - - &573 + - *331 + - *332 + - &577 name: pull_number description: The number that identifies the pull request. in: path @@ -89930,9 +91551,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *571 + schema: *575 examples: - default: *572 + default: *576 '304': *35 '404': *6 '406': @@ -89967,9 +91588,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: false content: @@ -90011,9 +91632,9 @@ paths: description: Response content: application/json: - schema: *571 + schema: *575 examples: - default: *572 + default: *576 '422': *15 '403': *27 x-github: @@ -90035,9 +91656,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 responses: '204': description: Response @@ -90062,9 +91683,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 responses: '204': description: Response @@ -90090,9 +91711,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: true content: @@ -90153,17 +91774,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '401': *23 '403': *27 '404': *6 @@ -90193,9 +91814,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 - *104 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -90216,9 +91837,9 @@ paths: application/json: schema: type: array - items: *569 + items: *573 examples: - default: *574 + default: *578 headers: Link: *66 x-github: @@ -90251,9 +91872,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: true content: @@ -90359,7 +91980,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *573 examples: example-for-a-multi-line-comment: value: @@ -90447,9 +92068,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 - *96 requestBody: required: true @@ -90472,7 +92093,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *573 examples: default: value: @@ -90558,9 +92179,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 - *17 - *19 responses: @@ -90570,9 +92191,9 @@ paths: application/json: schema: type: array - items: *458 + items: *462 examples: - default: *575 + default: *579 headers: Link: *66 x-github: @@ -90602,9 +92223,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 - *17 - *19 responses: @@ -90614,7 +92235,7 @@ paths: application/json: schema: type: array - items: *469 + items: *473 examples: default: value: @@ -90652,9 +92273,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 responses: '204': description: Response if pull request has been merged @@ -90677,9 +92298,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: false content: @@ -90791,9 +92412,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 responses: '200': description: Response @@ -90809,7 +92430,7 @@ paths: items: *4 teams: type: array - items: *187 + items: *191 required: - users - teams @@ -90868,9 +92489,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: false content: @@ -90907,7 +92528,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *466 examples: default: value: @@ -91443,9 +93064,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: true content: @@ -91479,7 +93100,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *466 examples: default: value: @@ -91964,9 +93585,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 - *17 - *19 responses: @@ -91976,7 +93597,7 @@ paths: application/json: schema: type: array - items: &576 + items: &580 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -92132,9 +93753,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: false content: @@ -92224,9 +93845,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: - default: &578 + default: &582 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -92289,10 +93910,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 - - &577 + - *331 + - *332 + - *577 + - &581 name: review_id description: The unique identifier of the review. in: path @@ -92304,9 +93925,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: - default: &579 + default: &583 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -92365,10 +93986,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 - *577 + - *581 requestBody: required: true content: @@ -92391,7 +94012,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: default: value: @@ -92453,18 +94074,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 - *577 + - *581 responses: '200': description: Response content: application/json: - schema: *576 + schema: *580 examples: - default: *578 + default: *582 '422': *7 '404': *6 x-github: @@ -92491,10 +94112,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *327 - - *328 - - *573 + - *331 + - *332 - *577 + - *581 - *17 - *19 responses: @@ -92592,9 +94213,9 @@ paths: _links: type: object properties: - self: *269 - html: *269 - pull_request: *269 + self: *273 + html: *273 + pull_request: *273 required: - self - html @@ -92752,10 +94373,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 - *577 + - *581 requestBody: required: true content: @@ -92784,7 +94405,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: default: value: @@ -92847,10 +94468,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 - *577 + - *581 requestBody: required: true content: @@ -92885,9 +94506,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: - default: *579 + default: *583 '404': *6 '422': *7 '403': *27 @@ -92909,9 +94530,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: false content: @@ -92975,8 +94596,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *327 - - *328 + - *331 + - *332 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -92989,9 +94610,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *584 examples: - default: &581 + default: &585 value: type: file encoding: base64 @@ -93033,8 +94654,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *327 - - *328 + - *331 + - *332 - name: dir description: The alternate path to look for a README file in: path @@ -93054,9 +94675,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *584 examples: - default: *581 + default: *585 '404': *6 '422': *15 x-github: @@ -93078,8 +94699,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -93089,7 +94710,7 @@ paths: application/json: schema: type: array - items: *582 + items: *586 examples: default: value: @@ -93183,8 +94804,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -93260,9 +94881,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *586 examples: - default: &586 + default: &590 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -93367,9 +94988,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *327 - - *328 - - &584 + - *331 + - *332 + - &588 name: asset_id description: The unique identifier of the asset. in: path @@ -93381,9 +95002,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *587 examples: - default: &585 + default: &589 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -93418,7 +95039,7 @@ paths: type: User site_admin: false '404': *6 - '302': *473 + '302': *477 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93434,9 +95055,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *327 - - *328 - - *584 + - *331 + - *332 + - *588 requestBody: required: false content: @@ -93465,9 +95086,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *587 examples: - default: *585 + default: *589 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93483,9 +95104,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *327 - - *328 - - *584 + - *331 + - *332 + - *588 responses: '204': description: Response @@ -93510,8 +95131,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -93597,16 +95218,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *582 + schema: *586 examples: - default: *586 + default: *590 '404': *6 x-github: githubCloudOnly: false @@ -93624,8 +95245,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *327 - - *328 + - *331 + - *332 - name: tag description: tag parameter in: path @@ -93638,9 +95259,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *586 examples: - default: *586 + default: *590 '404': *6 x-github: githubCloudOnly: false @@ -93662,9 +95283,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *327 - - *328 - - &587 + - *331 + - *332 + - &591 name: release_id description: The unique identifier of the release. in: path @@ -93678,9 +95299,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *582 + schema: *586 examples: - default: *586 + default: *590 '401': description: Unauthorized x-github: @@ -93698,9 +95319,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *327 - - *328 - - *587 + - *331 + - *332 + - *591 requestBody: required: false content: @@ -93764,9 +95385,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *586 examples: - default: *586 + default: *590 '404': description: Not Found if the discussion category name is invalid content: @@ -93787,9 +95408,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *327 - - *328 - - *587 + - *331 + - *332 + - *591 responses: '204': description: Response @@ -93810,9 +95431,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *327 - - *328 - - *587 + - *331 + - *332 + - *591 - *17 - *19 responses: @@ -93822,7 +95443,7 @@ paths: application/json: schema: type: array - items: *583 + items: *587 examples: default: value: @@ -93903,9 +95524,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *327 - - *328 - - *587 + - *331 + - *332 + - *591 - name: name in: query required: true @@ -93931,7 +95552,7 @@ paths: description: Response for successful upload content: application/json: - schema: *583 + schema: *587 examples: response-for-successful-upload: value: @@ -93986,9 +95607,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *327 - - *328 - - *587 + - *331 + - *332 + - *591 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -94012,9 +95633,9 @@ paths: application/json: schema: type: array - items: *456 + items: *460 examples: - default: *527 + default: *531 headers: Link: *66 '404': *6 @@ -94035,9 +95656,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *327 - - *328 - - *587 + - *331 + - *332 + - *591 requestBody: required: true content: @@ -94067,16 +95688,16 @@ paths: description: Reaction exists content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '201': description: Reaction created content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '422': *15 x-github: githubCloudOnly: false @@ -94098,10 +95719,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *327 - - *328 - - *587 - - *528 + - *331 + - *332 + - *591 + - *532 responses: '204': description: Response @@ -94125,9 +95746,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 - *17 - *19 responses: @@ -94143,8 +95764,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *289 - - &588 + - *293 + - &592 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -94163,69 +95784,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *290 - - *588 - - allOf: - - *291 - - *588 - - allOf: - - *292 - - *588 - - allOf: - - *589 - - *588 - - allOf: - - *293 - - *588 - allOf: - *294 - - *588 + - *592 - allOf: - *295 - - *588 + - *592 - allOf: - *296 - - *588 + - *592 + - allOf: + - *593 + - *592 - allOf: - *297 - - *588 + - *592 - allOf: - *298 - - *588 + - *592 - allOf: - *299 - - *588 + - *592 - allOf: - *300 - - *588 + - *592 - allOf: - *301 - - *588 + - *592 - allOf: - *302 - - *588 + - *592 - allOf: - *303 - - *588 + - *592 - allOf: - *304 - - *588 + - *592 - allOf: - *305 - - *588 + - *592 - allOf: - *306 - - *588 + - *592 - allOf: - *307 - - *588 + - *592 - allOf: - *308 - - *588 + - *592 - allOf: - *309 - - *588 + - *592 + - allOf: + - *310 + - *592 + - allOf: + - *311 + - *592 + - allOf: + - *312 + - *592 + - allOf: + - *313 + - *592 examples: default: value: @@ -94264,8 +95885,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 - name: includes_parents @@ -94276,7 +95897,7 @@ paths: schema: type: boolean default: true - - *590 + - *594 responses: '200': description: Response @@ -94284,7 +95905,7 @@ paths: application/json: schema: type: array - items: *310 + items: *314 examples: default: value: @@ -94331,8 +95952,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *331 + - *332 requestBody: description: Request body required: true @@ -94352,16 +95973,16 @@ paths: - tag - push default: branch - enforcement: *286 + enforcement: *290 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *287 - conditions: *284 + items: *291 + conditions: *288 rules: type: array description: An array of rules within the ruleset. - items: *591 + items: *595 required: - name - enforcement @@ -94392,9 +96013,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *314 examples: - default: &601 + default: &605 value: id: 42 name: super cool ruleset @@ -94442,12 +96063,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *327 - - *328 - - *592 - - *593 - - *594 - - *595 + - *331 + - *332 + - *596 + - *597 + - *598 + - *599 - *17 - *19 responses: @@ -94455,9 +96076,9 @@ paths: description: Response content: application/json: - schema: *596 + schema: *600 examples: - default: *597 + default: *601 '404': *6 '500': *53 x-github: @@ -94478,17 +96099,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *327 - - *328 - - *598 + - *331 + - *332 + - *602 responses: '200': description: Response content: application/json: - schema: *599 + schema: *603 examples: - default: *600 + default: *604 '404': *6 '500': *53 x-github: @@ -94516,8 +96137,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *331 + - *332 - name: ruleset_id description: The ID of the ruleset. in: path @@ -94537,9 +96158,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *314 examples: - default: *601 + default: *605 '404': *6 '500': *53 put: @@ -94557,8 +96178,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *331 + - *332 - name: ruleset_id description: The ID of the ruleset. in: path @@ -94583,16 +96204,16 @@ paths: - branch - tag - push - enforcement: *286 + enforcement: *290 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *287 - conditions: *284 + items: *291 + conditions: *288 rules: description: An array of rules within the ruleset. type: array - items: *591 + items: *595 examples: default: value: @@ -94620,9 +96241,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *314 examples: - default: *601 + default: *605 '404': *6 '422': *15 '500': *53 @@ -94641,8 +96262,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *331 + - *332 - name: ruleset_id description: The ID of the ruleset. in: path @@ -94665,8 +96286,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 - name: ruleset_id @@ -94682,9 +96303,9 @@ paths: application/json: schema: type: array - items: *313 + items: *317 examples: - default: *602 + default: *606 '404': *6 '500': *53 x-github: @@ -94703,8 +96324,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *327 - - *328 + - *331 + - *332 - name: ruleset_id description: The ID of the ruleset. in: path @@ -94722,7 +96343,7 @@ paths: description: Response content: application/json: - schema: *603 + schema: *607 examples: default: value: @@ -94777,25 +96398,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *327 - - *328 - - *604 - - *605 - - *606 - - *607 + - *331 + - *332 - *608 - *609 - *610 - *611 - - *60 - - *19 - - *17 - *612 - *613 - *614 - *615 + - *60 + - *19 + - *17 - *616 - *617 + - *618 + - *619 + - *620 + - *621 responses: '200': description: Response @@ -94803,7 +96424,7 @@ paths: application/json: schema: type: array - items: &621 + items: &625 type: object properties: number: *171 @@ -94819,8 +96440,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *618 - resolution: *619 + state: *622 + resolution: *623 resolved_at: type: - string @@ -94926,7 +96547,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *620 + - *624 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -95085,16 +96706,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *327 - - *328 - - *424 - - *617 + - *331 + - *332 + - *428 + - *621 responses: '200': description: Response content: application/json: - schema: *621 + schema: *625 examples: default: value: @@ -95148,9 +96769,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *327 - - *328 - - *424 + - *331 + - *332 + - *428 requestBody: required: true content: @@ -95158,8 +96779,8 @@ paths: schema: type: object properties: - state: *618 - resolution: *619 + state: *622 + resolution: *623 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -95172,6 +96793,16 @@ paths: type: - string - 'null' + validity: + type: + - string + - 'null' + enum: + - active + - inactive + - + description: Sets the validity of the secret scanning alert. Can + be `active`, `inactive`, or `null` to clear the override. anyOf: - required: - state @@ -95197,7 +96828,7 @@ paths: description: Response content: application/json: - schema: *621 + schema: *625 examples: default: value: @@ -95269,7 +96900,8 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment, - or assignee does not have write access to the repository + assignee does not have write access to the repository, or the requested + validity change could not be applied to this alert '503': *114 x-github: enabledForGitHubApps: true @@ -95292,9 +96924,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *327 - - *328 - - *424 + - *331 + - *332 + - *428 - *19 - *17 responses: @@ -95305,7 +96937,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &770 + items: &775 type: object properties: type: @@ -95332,10 +96964,6 @@ paths: - commit details: oneOf: - - *622 - - *623 - - *624 - - *625 - *626 - *627 - *628 @@ -95345,6 +96973,10 @@ paths: - *632 - *633 - *634 + - *635 + - *636 + - *637 + - *638 examples: default: value: @@ -95430,8 +97062,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -95439,14 +97071,14 @@ paths: schema: type: object properties: - reason: &636 + reason: &640 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *635 + placeholder_id: *639 required: - reason - placeholder_id @@ -95463,7 +97095,7 @@ paths: schema: type: object properties: - reason: *636 + reason: *640 expire_at: type: - string @@ -95510,8 +97142,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -95526,7 +97158,7 @@ paths: properties: incremental_scans: type: array - items: &637 + items: &641 description: Information on a single scan performed by secret scanning on the repository type: object @@ -95554,15 +97186,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *637 + items: *641 backfill_scans: type: array - items: *637 + items: *641 custom_pattern_backfill_scans: type: array items: allOf: - - *637 + - *641 - type: object properties: pattern_name: @@ -95575,7 +97207,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *637 + items: *641 examples: default: value: @@ -95640,8 +97272,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *327 - - *328 + - *331 + - *332 - *60 - name: sort description: The property to sort the results by. @@ -95685,9 +97317,9 @@ paths: application/json: schema: type: array - items: *638 + items: *642 examples: - default: *639 + default: *643 '400': *14 '404': *6 x-github: @@ -95710,8 +97342,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -95791,7 +97423,7 @@ paths: login: type: string description: The username of the user credited. - type: *316 + type: *320 required: - login - type @@ -95881,9 +97513,9 @@ paths: description: Response content: application/json: - schema: *638 + schema: *642 examples: - default: &641 + default: &645 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -96113,8 +97745,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -96227,7 +97859,7 @@ paths: description: Response content: application/json: - schema: *638 + schema: *642 examples: default: value: @@ -96373,17 +98005,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *327 - - *328 - - *640 + - *331 + - *332 + - *644 responses: '200': description: Response content: application/json: - schema: *638 + schema: *642 examples: - default: *641 + default: *645 '403': *27 '404': *6 x-github: @@ -96407,9 +98039,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *327 - - *328 - - *640 + - *331 + - *332 + - *644 requestBody: required: true content: @@ -96489,7 +98121,7 @@ paths: login: type: string description: The username of the user credited. - type: *316 + type: *320 required: - login - type @@ -96580,10 +98212,10 @@ paths: description: Response content: application/json: - schema: *638 + schema: *642 examples: - default: *641 - add_credit: *641 + default: *645 + add_credit: *645 '403': *27 '404': *6 '422': @@ -96621,9 +98253,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *327 - - *328 - - *640 + - *331 + - *332 + - *644 responses: '202': *37 '400': *14 @@ -96650,17 +98282,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *327 - - *328 - - *640 + - *331 + - *332 + - *644 responses: '202': description: Response content: application/json: - schema: *330 + schema: *334 examples: - default: *332 + default: *336 '400': *14 '422': *15 '403': *27 @@ -96686,8 +98318,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -96783,8 +98415,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -96793,7 +98425,7 @@ paths: application/json: schema: type: array - items: &642 + items: &646 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -96826,8 +98458,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -96905,8 +98537,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -97000,8 +98632,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -97155,8 +98787,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -97166,7 +98798,7 @@ paths: application/json: schema: type: array - items: *642 + items: *646 examples: default: value: @@ -97199,8 +98831,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *327 - - *328 + - *331 + - *332 - name: sha in: path required: true @@ -97256,7 +98888,7 @@ paths: description: Response content: application/json: - schema: *643 + schema: *647 examples: default: value: @@ -97310,8 +98942,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -97343,14 +98975,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &644 + schema: &648 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -97423,8 +99055,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: false content: @@ -97450,7 +99082,7 @@ paths: description: Response content: application/json: - schema: *644 + schema: *648 examples: default: value: @@ -97477,8 +99109,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -97498,8 +99130,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -97581,8 +99213,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *327 - - *328 + - *331 + - *332 - name: ref in: path required: true @@ -97618,8 +99250,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -97629,9 +99261,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - default: *248 + default: *252 headers: Link: *66 '404': *6 @@ -97651,8 +99283,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *327 - - *328 + - *331 + - *332 - *19 - *17 responses: @@ -97660,7 +99292,7 @@ paths: description: Response content: application/json: - schema: &645 + schema: &649 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -97672,7 +99304,7 @@ paths: required: - names examples: - default: &646 + default: &650 value: names: - octocat @@ -97695,8 +99327,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -97727,9 +99359,9 @@ paths: description: Response content: application/json: - schema: *645 + schema: *649 examples: - default: *646 + default: *650 '404': *6 '422': *7 x-github: @@ -97750,9 +99382,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *327 - - *328 - - &647 + - *331 + - *332 + - &651 name: per description: The time frame to display results for. in: query @@ -97783,7 +99415,7 @@ paths: - 128 clones: type: array - items: &648 + items: &652 title: Traffic type: object properties: @@ -97870,8 +99502,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -97965,8 +99597,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -98029,9 +99661,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *327 - - *328 - - *647 + - *331 + - *332 + - *651 responses: '200': description: Response @@ -98052,7 +99684,7 @@ paths: - 3782 views: type: array - items: *648 + items: *652 required: - uniques - count @@ -98129,8 +99761,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -98403,8 +100035,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -98427,8 +100059,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -98450,8 +100082,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -98477,8 +100109,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *327 - - *328 + - *331 + - *332 - name: ref in: path required: true @@ -98570,9 +100202,9 @@ paths: description: Response content: application/json: - schema: *330 + schema: *334 examples: - default: *332 + default: *336 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -98824,7 +100456,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &649 + text_matches: &653 title: Search Result Text Matches type: array items: @@ -98987,7 +100619,7 @@ paths: enum: - author-date - committer-date - - &650 + - &654 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -99056,7 +100688,7 @@ paths: committer: anyOf: - type: 'null' - - *392 + - *396 comment_count: type: integer message: @@ -99075,7 +100707,7 @@ paths: url: type: string format: uri - verification: *511 + verification: *515 required: - author - committer @@ -99090,7 +100722,7 @@ paths: committer: anyOf: - type: 'null' - - *392 + - *396 parents: type: array items: @@ -99107,7 +100739,7 @@ paths: type: number node_id: type: string - text_matches: *649 + text_matches: *653 required: - sha - node_id @@ -99299,7 +100931,7 @@ paths: - interactions - created - updated - - *650 + - *654 - *17 - *19 - name: advanced_search @@ -99413,11 +101045,11 @@ paths: type: - string - 'null' - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: type: string state_reason: @@ -99427,7 +101059,7 @@ paths: milestone: anyOf: - type: 'null' - - *268 + - *272 comments: type: integer created_at: @@ -99441,7 +101073,7 @@ paths: - string - 'null' format: date-time - text_matches: *649 + text_matches: *653 pull_request: type: object properties: @@ -99490,7 +101122,7 @@ paths: timeline_url: type: string format: uri - type: *232 + type: *236 performed_via_github_app: anyOf: - type: 'null' @@ -99705,7 +101337,7 @@ paths: enum: - created - updated - - *650 + - *654 - *17 - *19 responses: @@ -99750,7 +101382,7 @@ paths: - 'null' score: type: number - text_matches: *649 + text_matches: *653 required: - id - node_id @@ -99835,7 +101467,7 @@ paths: - forks - help-wanted-issues - updated - - *650 + - *654 - *17 - *19 responses: @@ -100081,7 +101713,7 @@ paths: - admin - pull - push - text_matches: *649 + text_matches: *653 temp_clone_token: type: string allow_merge_commit: @@ -100389,7 +102021,7 @@ paths: - string - 'null' format: uri - text_matches: *649 + text_matches: *653 related: type: - array @@ -100582,7 +102214,7 @@ paths: - followers - repositories - joined - - *650 + - *654 - *17 - *19 responses: @@ -100692,7 +102324,7 @@ paths: type: - boolean - 'null' - text_matches: *649 + text_matches: *653 blog: type: - string @@ -100774,7 +102406,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &653 + - &657 name: team_id description: The unique identifier of the team. in: path @@ -100786,9 +102418,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '404': *6 x-github: githubCloudOnly: false @@ -100815,7 +102447,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *653 + - *657 requestBody: required: true content: @@ -100879,16 +102511,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '201': description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '404': *6 '422': *15 '403': *27 @@ -100916,7 +102548,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *653 + - *657 responses: '204': description: Response @@ -100945,7 +102577,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *653 + - *657 - *17 - *19 responses: @@ -100955,9 +102587,9 @@ paths: application/json: schema: type: array - items: *226 + items: *230 examples: - default: *227 + default: *231 headers: Link: *66 x-github: @@ -100983,7 +102615,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *653 + - *657 - name: role description: Filters members returned by their role in the team. in: query @@ -101034,7 +102666,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *653 + - *657 - *70 responses: '204': @@ -101071,7 +102703,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *653 + - *657 - *70 responses: '204': @@ -101111,7 +102743,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *653 + - *657 - *70 responses: '204': @@ -101148,16 +102780,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *653 + - *657 - *70 responses: '200': description: Response content: application/json: - schema: *326 + schema: *330 examples: - response-if-user-is-a-team-maintainer: *654 + response-if-user-is-a-team-maintainer: *658 '404': *6 x-github: githubCloudOnly: false @@ -101190,7 +102822,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *653 + - *657 - *70 requestBody: required: false @@ -101216,9 +102848,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *330 examples: - response-if-users-membership-with-team-is-now-pending: *655 + response-if-users-membership-with-team-is-now-pending: *659 '403': description: Forbidden if team synchronization is set up '422': @@ -101252,7 +102884,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *653 + - *657 - *70 responses: '204': @@ -101280,7 +102912,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *653 + - *657 - *17 - *19 responses: @@ -101292,7 +102924,7 @@ paths: type: array items: *153 examples: - default: *262 + default: *266 headers: Link: *66 '404': *6 @@ -101322,15 +102954,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *653 - - *327 - - *328 + - *657 + - *331 + - *332 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *656 + schema: *660 examples: alternative-response-with-extra-repository-information: value: @@ -101480,9 +103112,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *653 - - *327 - - *328 + - *657 + - *331 + - *332 requestBody: required: false content: @@ -101532,9 +103164,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *653 - - *327 - - *328 + - *657 + - *331 + - *332 responses: '204': description: Response @@ -101559,7 +103191,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *653 + - *657 - *17 - *19 responses: @@ -101569,9 +103201,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - response-if-child-teams-exist: *657 + response-if-child-teams-exist: *661 headers: Link: *66 '404': *6 @@ -101604,7 +103236,7 @@ paths: application/json: schema: oneOf: - - &658 + - &662 title: Private User description: Private User type: object @@ -101854,7 +103486,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - &683 + - &687 title: Public User description: Public User type: object @@ -102188,7 +103820,7 @@ paths: description: Response content: application/json: - schema: *658 + schema: *662 examples: default: value: @@ -102391,9 +104023,9 @@ paths: type: integer codespaces: type: array - items: *237 + items: *241 examples: - default: *238 + default: *242 '304': *35 '500': *53 '401': *23 @@ -102532,17 +104164,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '401': *23 '403': *27 '404': *6 @@ -102586,7 +104218,7 @@ paths: type: integer secrets: type: array - items: &659 + items: &663 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -102628,7 +104260,7 @@ paths: - visibility - selected_repositories_url examples: - default: *449 + default: *453 headers: Link: *66 x-github: @@ -102706,7 +104338,7 @@ paths: description: Response content: application/json: - schema: *659 + schema: *663 examples: default: value: @@ -102852,7 +104484,7 @@ paths: type: array items: *153 examples: - default: *188 + default: *192 '401': *23 '403': *27 '404': *6 @@ -102996,15 +104628,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *239 + - *243 responses: '200': description: Response content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '304': *35 '500': *53 '401': *23 @@ -103030,7 +104662,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *239 + - *243 requestBody: required: false content: @@ -103060,9 +104692,9 @@ paths: description: Response content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '401': *23 '403': *27 '404': *6 @@ -103084,7 +104716,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *239 + - *243 responses: '202': *37 '304': *35 @@ -103113,13 +104745,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *239 + - *243 responses: '202': description: Response content: application/json: - schema: &660 + schema: &664 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -103172,7 +104804,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &661 + default: &665 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -103204,7 +104836,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *239 + - *243 - name: export_id in: path required: true @@ -103217,9 +104849,9 @@ paths: description: Response content: application/json: - schema: *660 + schema: *664 examples: - default: *661 + default: *665 '404': *6 x-github: githubCloudOnly: false @@ -103240,7 +104872,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *239 + - *243 responses: '200': description: Response @@ -103256,9 +104888,9 @@ paths: type: integer machines: type: array - items: *448 + items: *452 examples: - default: *662 + default: *666 '304': *35 '500': *53 '401': *23 @@ -103287,7 +104919,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *239 + - *243 requestBody: required: true content: @@ -103343,11 +104975,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *330 + repository: *334 machine: anyOf: - type: 'null' - - *448 + - *452 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -104144,15 +105776,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *239 + - *243 responses: '200': description: Response content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '304': *35 '500': *53 '400': *14 @@ -104184,15 +105816,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *239 + - *243 responses: '200': description: Response content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '500': *53 '401': *23 '403': *27 @@ -104222,9 +105854,9 @@ paths: application/json: schema: type: array - items: *249 + items: *253 examples: - default: &673 + default: &677 value: - id: 197 name: hello_docker @@ -104325,7 +105957,7 @@ paths: application/json: schema: type: array - items: &663 + items: &667 title: Email description: Email type: object @@ -104395,9 +106027,9 @@ paths: application/json: schema: type: array - items: *663 + items: *667 examples: - default: &675 + default: &679 value: - email: octocat@github.com verified: true @@ -104474,7 +106106,7 @@ paths: application/json: schema: type: array - items: *663 + items: *667 examples: default: value: @@ -104732,7 +106364,7 @@ paths: application/json: schema: type: array - items: &664 + items: &668 title: GPG Key description: A unique encryption key type: object @@ -104877,7 +106509,7 @@ paths: - subkeys - revoked examples: - default: &692 + default: &697 value: - id: 3 name: Octocat's GPG Key @@ -104962,9 +106594,9 @@ paths: description: Response content: application/json: - schema: *664 + schema: *668 examples: - default: &665 + default: &669 value: id: 3 name: Octocat's GPG Key @@ -105021,7 +106653,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &666 + - &670 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -105033,9 +106665,9 @@ paths: description: Response content: application/json: - schema: *664 + schema: *668 examples: - default: *665 + default: *669 '404': *6 '304': *35 '403': *27 @@ -105058,7 +106690,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *666 + - *670 responses: '204': description: Response @@ -105337,12 +106969,12 @@ paths: application/json: schema: anyOf: - - *224 + - *228 - type: object properties: {} additionalProperties: false examples: - default: *225 + default: *229 '204': description: Response when there are no restrictions x-github: @@ -105366,7 +106998,7 @@ paths: required: true content: application/json: - schema: *522 + schema: *526 examples: default: value: @@ -105377,7 +107009,7 @@ paths: description: Response content: application/json: - schema: *224 + schema: *228 examples: default: value: @@ -105458,7 +107090,7 @@ paths: - closed - all default: open - - *235 + - *239 - name: sort description: What to sort results by. in: query @@ -105483,7 +107115,7 @@ paths: type: array items: *82 examples: - default: *236 + default: *240 headers: Link: *66 '404': *6 @@ -105516,7 +107148,7 @@ paths: application/json: schema: type: array - items: &667 + items: &671 title: Key description: Key type: object @@ -105619,9 +107251,9 @@ paths: description: Response content: application/json: - schema: *667 + schema: *671 examples: - default: &668 + default: &672 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -105654,15 +107286,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *553 + - *557 responses: '200': description: Response content: application/json: - schema: *667 + schema: *671 examples: - default: *668 + default: *672 '404': *6 '304': *35 '403': *27 @@ -105685,7 +107317,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *553 + - *557 responses: '204': description: Response @@ -105718,7 +107350,7 @@ paths: application/json: schema: type: array - items: &669 + items: &673 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -105797,7 +107429,7 @@ paths: - account - plan examples: - default: &670 + default: &674 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -105859,9 +107491,9 @@ paths: application/json: schema: type: array - items: *669 + items: *673 examples: - default: *670 + default: *674 headers: Link: *66 '304': *35 @@ -105901,7 +107533,7 @@ paths: application/json: schema: type: array - items: *241 + items: *245 examples: default: value: @@ -106015,7 +107647,7 @@ paths: description: Response content: application/json: - schema: *241 + schema: *245 examples: default: value: @@ -106102,7 +107734,7 @@ paths: description: Response content: application/json: - schema: *241 + schema: *245 examples: default: value: @@ -106174,7 +107806,7 @@ paths: application/json: schema: type: array - items: *243 + items: *247 examples: default: value: @@ -106436,7 +108068,7 @@ paths: description: Response content: application/json: - schema: *243 + schema: *247 examples: default: value: @@ -106616,7 +108248,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *244 + - *248 - name: exclude in: query required: false @@ -106629,7 +108261,7 @@ paths: description: Response content: application/json: - schema: *243 + schema: *247 examples: default: value: @@ -106823,7 +108455,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *244 + - *248 responses: '302': description: Response @@ -106849,7 +108481,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *244 + - *248 responses: '204': description: Response @@ -106878,8 +108510,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *244 - - *671 + - *248 + - *675 responses: '204': description: Response @@ -106903,7 +108535,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *244 + - *248 - *17 - *19 responses: @@ -106992,7 +108624,7 @@ paths: - docker - nuget - container - - *672 + - *676 - *19 - *17 responses: @@ -107002,10 +108634,10 @@ paths: application/json: schema: type: array - items: *249 + items: *253 examples: - default: *673 - '400': *674 + default: *677 + '400': *678 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107025,16 +108657,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *251 - - *252 + - *255 + - *256 responses: '200': description: Response content: application/json: - schema: *249 + schema: *253 examples: - default: &693 + default: &698 value: id: 40201 name: octo-name @@ -107147,8 +108779,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *251 - - *252 + - *255 + - *256 responses: '204': description: Response @@ -107178,8 +108810,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *251 - - *252 + - *255 + - *256 - name: token description: package token schema: @@ -107211,8 +108843,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *251 - - *252 + - *255 + - *256 - *19 - *17 - name: state @@ -107232,7 +108864,7 @@ paths: application/json: schema: type: array - items: *253 + items: *257 examples: default: value: @@ -107281,15 +108913,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *251 - - *252 - - *254 + - *255 + - *256 + - *258 responses: '200': description: Response content: application/json: - schema: *253 + schema: *257 examples: default: value: @@ -107325,9 +108957,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *251 - - *252 - - *254 + - *255 + - *256 + - *258 responses: '204': description: Response @@ -107357,9 +108989,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *251 - - *252 - - *254 + - *255 + - *256 + - *258 responses: '204': description: Response @@ -107396,9 +109028,9 @@ paths: application/json: schema: type: array - items: *663 + items: *667 examples: - default: *675 + default: *679 headers: Link: *66 '304': *35 @@ -107511,7 +109143,7 @@ paths: type: array items: *78 examples: - default: &682 + default: &686 summary: Default response value: - id: 1296269 @@ -107829,9 +109461,9 @@ paths: description: Response content: application/json: - schema: *330 + schema: *334 examples: - default: *332 + default: *336 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -107870,9 +109502,9 @@ paths: application/json: schema: type: array - items: *524 + items: *528 examples: - default: *676 + default: *680 headers: Link: *66 '304': *35 @@ -107895,7 +109527,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *228 + - *232 responses: '204': description: Response @@ -107919,7 +109551,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *228 + - *232 responses: '204': description: Response @@ -107952,7 +109584,7 @@ paths: application/json: schema: type: array - items: &677 + items: &681 title: Social account description: Social media account type: object @@ -107969,7 +109601,7 @@ paths: - provider - url examples: - default: &678 + default: &682 value: - provider: twitter url: https://twitter.com/github @@ -108032,9 +109664,9 @@ paths: application/json: schema: type: array - items: *677 + items: *681 examples: - default: *678 + default: *682 '422': *15 '304': *35 '404': *6 @@ -108122,7 +109754,7 @@ paths: application/json: schema: type: array - items: &679 + items: &683 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -108142,7 +109774,7 @@ paths: - title - created_at examples: - default: &711 + default: &716 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -108207,9 +109839,9 @@ paths: description: Response content: application/json: - schema: *679 + schema: *683 examples: - default: &680 + default: &684 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -108239,7 +109871,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &681 + - &685 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -108251,9 +109883,9 @@ paths: description: Response content: application/json: - schema: *679 + schema: *683 examples: - default: *680 + default: *684 '404': *6 '304': *35 '403': *27 @@ -108276,7 +109908,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *681 + - *685 responses: '204': description: Response @@ -108305,7 +109937,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &712 + - &717 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -108330,11 +109962,11 @@ paths: type: array items: *78 examples: - default-response: *682 + default-response: *686 application/vnd.github.v3.star+json: schema: type: array - items: &713 + items: &718 title: Starred Repository description: Starred Repository type: object @@ -108490,8 +110122,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response if this repository is starred by you @@ -108519,8 +110151,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -108544,8 +110176,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -108580,7 +110212,7 @@ paths: type: array items: *153 examples: - default: *262 + default: *266 headers: Link: *66 '304': *35 @@ -108617,7 +110249,7 @@ paths: application/json: schema: type: array - items: *323 + items: *327 examples: default: value: @@ -108703,10 +110335,10 @@ paths: application/json: schema: oneOf: - - *658 - - *683 + - *662 + - *687 examples: - default-response: &687 + default-response: &691 summary: Default response value: login: octocat @@ -108741,7 +110373,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &688 + response-with-git-hub-plan-information: &692 summary: Response with GitHub plan information value: login: octocat @@ -108798,14 +110430,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &685 + - &689 name: user_id description: The unique identifier of the user. in: path required: true schema: type: string - - *267 + - *271 requestBody: required: true description: Details of the draft item to create in the project. @@ -108839,9 +110471,9 @@ paths: description: Response content: application/json: - schema: *272 + schema: *276 examples: - draft_issue: *273 + draft_issue: *277 '304': *35 '403': *27 '401': *23 @@ -108864,7 +110496,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *684 + - *688 - *17 responses: '200': @@ -108899,8 +110531,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *685 - - *267 + - *689 + - *271 requestBody: required: true content: @@ -108974,17 +110606,17 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *686 + schema: *690 examples: table_view: summary: Response for creating a table view - value: *277 + value: *281 board_view: summary: Response for creating a board view with filter - value: *277 + value: *281 roadmap_view: summary: Response for creating a roadmap view - value: *277 + value: *281 '304': *35 '403': *27 '401': *23 @@ -109026,11 +110658,11 @@ paths: application/json: schema: oneOf: - - *658 - - *683 + - *662 + - *687 examples: - default-response: *687 - response-with-git-hub-plan-information: *688 + default-response: *691 + response-with-git-hub-plan-information: *692 '404': *6 x-github: githubCloudOnly: false @@ -109080,8 +110712,8 @@ paths: required: - subject_digests examples: - default: *689 - withPredicateType: *690 + default: *693 + withPredicateType: *694 responses: '200': description: Response @@ -109121,7 +110753,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *691 + default: *695 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109310,7 +110942,7 @@ paths: initiator: type: string examples: - default: *388 + default: *392 '201': description: Response content: @@ -109327,6 +110959,1244 @@ paths: enabledForGitHubApps: true category: users subcategory: attestations + "/users/{username}/copilot-spaces": + get: + summary: List Copilot Spaces for a user + description: |- + Lists Copilot Spaces owned by a user. The authenticated user must have read access to the user's Copilot Spaces. + + Only Spaces that are readable by the authenticated user are returned. This includes the user's own spaces, and public user spaces when accessing another user's spaces. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-copilot-spaces-for-a-user + parameters: + - *70 + - name: per_page + description: The number of results per page (max 100). + in: query + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: before + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + in: query + schema: + type: string + - name: after + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. + in: query + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - spaces + properties: + spaces: + type: array + description: The list of Copilot Spaces on this page of results. + items: *187 + examples: + default: + summary: Example response for listing user copilot spaces + value: + spaces: + - id: 42 + number: 1 + name: Personal Research Space + description: My personal space for research and development + owner: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-16T10:15:00Z' + updated_at: '2023-02-16T16:30:00Z' + html_url: https://github.com/copilot/spaces/octocat/1 + api_url: https://api.github.com/user/1/copilot-spaces/1 + - id: 43 + number: 2 + name: Learning Space + description: Space for learning new technologies + owner: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-17T08:20:00Z' + updated_at: '2023-02-17T14:45:00Z' + html_url: https://github.com/copilot/spaces/octocat/2 + api_url: https://api.github.com/user/1/copilot-spaces/2 + headers: + Link: *66 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + post: + summary: Create a Copilot Space for a user + description: |- + Creates a new Copilot Space owned by a user. Only the authenticated user can create spaces for their own account. + + Users can create personal Copilot Spaces for their individual use. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-a-copilot-space-for-a-user + parameters: + - *70 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - My Development Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Personal space for development assistance + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Help me with React development patterns and best practices + base_role: + type: string + enum: + - reader + - no_access + description: |- + The base role that determines default permissions for the space. + - `no_access`: No default access (default) + - `reader`: Makes the space publicly readable + Note: User spaces do not support writer or admin base roles. + default: no_access + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + required: + - name + examples: + default: + value: + name: My Development Space + description: Personal space for development assistance + general_instructions: Help me with React development patterns and + best practices + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 789012 + file_path: src/components/App.js + - resource_type: free_text + metadata: + name: Development Notes + text: Focus on clean code principles and modern React patterns + responses: + '201': + description: Response + content: + application/json: + schema: *187 + examples: + default: &696 + summary: Example response for a user copilot space + value: + id: 42 + number: 5 + name: My Development Space + description: Personal space for React development patterns + general_instructions: Focus on React functional components, hooks, + and modern development patterns + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-15T08:30:00Z' + updated_at: '2023-02-15T14:45:00Z' + html_url: https://github.com/copilot/spaces/octocat/5 + api_url: https://api.github.com/user/1/copilot-spaces/5 + base_role: no_access + resources_attributes: + - id: 789 + resource_type: github_file + metadata: + repository_id: 1234 + file_path: src/components/App.tsx + - id: 790 + resource_type: free_text + metadata: + name: React Best Practices + text: Use functional components with hooks + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + "/users/{username}/copilot-spaces/{space_number}": + get: + summary: Get a Copilot Space for a user + description: |- + Gets details about a specific Copilot Space owned by a user. The authenticated user must have read access to the Space. + + Private user spaces require the authenticated user to be the owner of the space. + Public user spaces are accessible to any authenticated user. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *187 + examples: + default: *696 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + put: + summary: Set a Copilot Space for a user + description: |- + Updates a Copilot Space owned by a user. Only the authenticated user can update spaces for their own account. + + Users can update their personal Copilot Spaces. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - Updated Development Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Updated personal space for development assistance + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Updated instructions to help me with React development patterns + and best practices + base_role: + type: string + enum: + - reader + - no_access + description: |- + The base role that determines default permissions for the space. Changing this field requires admin permissions. + - `no_access`: No default access (default) + - `reader`: Makes the space publicly readable + Note: User spaces do not support writer or admin base roles. + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + examples: + default: + value: + name: Updated Development Space + description: Updated personal space for development assistance + general_instructions: Updated instructions to help me with React + development patterns and best practices + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 789012 + file_path: src/components/UpdatedApp.js + - id: 123 + _destroy: true + - id: 456 + resource_type: free_text + metadata: + name: Updated Development Notes + text: Updated focus on clean code principles and modern React + patterns + responses: + '200': + description: Response + content: + application/json: + schema: *187 + examples: + default: *696 + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + delete: + summary: Delete a Copilot Space for a user + description: |- + Deletes a Copilot Space owned by a user. The authenticated user must be the owner of the space. + + **Warning:** This action is permanent and cannot be undone. Deleting a space will remove all associated resources and configurations. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '204': + description: The Copilot Space has been successfully deleted. + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + "/users/{username}/copilot-spaces/{space_number}/collaborators": + get: + summary: List collaborators for a Copilot Space for a user + description: |- + Lists all collaborators for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + Each collaborator entry specifies which user has access to the space and at what level (reader, writer, or admin). The space owner is excluded from this list. + + Team collaborators are not supported for user-owned Copilot Spaces. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-collaborators-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - collaborators + properties: + collaborators: + type: array + description: The list of collaborators for this Copilot Space. + items: *189 + examples: + default: + value: + collaborators: + - actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + - actor_type: User + role: reader + login: github-user + id: 67890 + node_id: MDQ6VXNlcjY3ODkw + avatar_url: https://github.com/images/error/other_user.gif + gravatar_id: '' + url: https://api.github.com/users/github-user + html_url: https://github.com/github-user + followers_url: https://api.github.com/users/github-user/followers + following_url: https://api.github.com/users/github-user/following{/other_user} + gists_url: https://api.github.com/users/github-user/gists{/gist_id} + starred_url: https://api.github.com/users/github-user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github-user/subscriptions + organizations_url: https://api.github.com/users/github-user/orgs + repos_url: https://api.github.com/users/github-user/repos + events_url: https://api.github.com/users/github-user/events{/privacy} + received_events_url: https://api.github.com/users/github-user/received_events + type: User + user_view_type: public + site_admin: false + name: GitHub User + company: + blog: '' + location: + email: + hireable: + bio: + twitter_username: + public_repos: 5 + public_gists: 0 + followers: 10 + following: 5 + created_at: '2010-01-14T04:33:35Z' + updated_at: '2010-01-14T04:33:35Z' + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + post: + summary: Add a collaborator to a Copilot Space for a user + description: |- + Adds a collaborator to a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + Team collaborators are not supported for user-owned Copilot Spaces. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/add-collaborator-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - actor_type + - actor_identifier + - role + properties: + actor_type: + type: string + enum: + - User + - Team + description: The type of actor (must be `User` for user-owned spaces; + `Team` will be rejected). + actor_identifier: + type: string + description: The username of the collaborator. The numeric user + ID is also accepted. + role: + type: string + enum: + - reader + - writer + - admin + description: The role to grant to the collaborator. + examples: + default: + value: + actor_type: User + actor_identifier: octocat + role: writer + responses: + '201': + description: Response + content: + application/json: + schema: *189 + examples: + default: + value: + actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": + put: + summary: Set a collaborator role for a Copilot Space for a user + description: |- + Updates the role of a collaborator for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-collaborator-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (must be `User` for user-owned spaces; `Team` + will be rejected). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username of the collaborator. The numeric user ID is also + accepted. + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - role + properties: + role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: The new role to grant to the collaborator. Use `no_access` + to remove the collaborator. + examples: + default: + value: + role: admin + responses: + '200': + description: Response + content: + application/json: + schema: *189 + examples: + default: + value: + actor_type: User + role: admin + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + '204': + description: Response when `role` is `no_access` and the collaborator was + removed. + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + delete: + summary: Remove a collaborator from a Copilot Space for a user + description: |- + Removes a collaborator from a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/remove-collaborator-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (must be `User` for user-owned spaces; `Team` + will be rejected). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username of the collaborator. The numeric user ID is also + accepted. + in: path + required: true + schema: + type: string + responses: + '204': + description: Response + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + "/users/{username}/copilot-spaces/{space_number}/resources": + get: + summary: List resources for a Copilot Space for a user + description: |- + Lists all resources attached to a specific Copilot Space owned by a user. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-resources-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - resources + properties: + resources: + type: array + description: The list of resources attached to this Copilot Space. + items: *190 + examples: + default: + value: + resources: + - id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + post: + summary: Create a resource for a Copilot Space for a user + description: |- + Creates a new resource in a specific Copilot Space owned by a user. + The authenticated user must have write permissions on the space. + + The following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`. + The `uploaded_text_file` and `media_content` types are not supported via this endpoint. + + For `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status. + + OAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - resource_type + - metadata + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + description: The type of resource to create. + metadata: + type: object + description: Resource-specific metadata. + additionalProperties: true + examples: + free_text: + value: + resource_type: free_text + metadata: + name: notes.txt + text: Some helpful notes + repository: + value: + resource_type: repository + metadata: + repository_id: 42 + github_file: + value: + resource_type: github_file + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + responses: + '201': + description: Resource created + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '200': + description: Duplicate github_file resource already exists + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: github_file + copilot_chat_attachment_id: + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}": + get: + summary: Get a resource for a Copilot Space for a user + description: |- + Gets a specific resource attached to a Copilot Space owned by a user. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + put: + summary: Set a resource for a Copilot Space for a user + description: |- + Updates the metadata of a resource in a specific Copilot Space owned by a user. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + description: Updated resource-specific metadata. + additionalProperties: true + examples: + default: + value: + metadata: + name: updated-notes.txt + text: Updated content + responses: + '200': + description: Response + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: updated-notes.txt + text: Updated content + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T12:00:00Z' + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + delete: + summary: Delete a resource from a Copilot Space for a user + description: |- + Deletes a resource from a specific Copilot Space owned by a user. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources "/users/{username}/docker/conflicts": get: summary: Get list of conflicting packages during Docker migration for user @@ -109349,9 +112219,9 @@ paths: application/json: schema: type: array - items: *249 + items: *253 examples: - default: *673 + default: *677 '403': *27 '401': *23 x-github: @@ -109735,9 +112605,9 @@ paths: application/json: schema: type: array - items: *664 + items: *668 examples: - default: *692 + default: *697 headers: Link: *66 x-github: @@ -109841,7 +112711,7 @@ paths: application/json: schema: *20 examples: - default: *521 + default: *525 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -109966,7 +112836,7 @@ paths: - docker - nuget - container - - *672 + - *676 - *70 - *19 - *17 @@ -109977,12 +112847,12 @@ paths: application/json: schema: type: array - items: *249 + items: *253 examples: - default: *673 + default: *677 '403': *27 '401': *23 - '400': *674 + '400': *678 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -110002,17 +112872,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *251 - - *252 + - *255 + - *256 - *70 responses: '200': description: Response content: application/json: - schema: *249 + schema: *253 examples: - default: *693 + default: *698 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -110033,8 +112903,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *251 - - *252 + - *255 + - *256 - *70 responses: '204': @@ -110067,8 +112937,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *251 - - *252 + - *255 + - *256 - *70 - name: token description: package token @@ -110101,8 +112971,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *251 - - *252 + - *255 + - *256 - *70 responses: '200': @@ -110111,7 +112981,7 @@ paths: application/json: schema: type: array - items: *253 + items: *257 examples: default: value: @@ -110169,16 +113039,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *251 - - *252 - - *254 + - *255 + - *256 + - *258 - *70 responses: '200': description: Response content: application/json: - schema: *253 + schema: *257 examples: default: value: @@ -110213,10 +113083,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *251 - - *252 + - *255 + - *256 - *70 - - *254 + - *258 responses: '204': description: Response @@ -110248,10 +113118,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *251 - - *252 + - *255 + - *256 - *70 - - *254 + - *258 responses: '204': description: Response @@ -110292,9 +113162,9 @@ paths: application/json: schema: type: array - items: *265 + items: *269 examples: - default: *266 + default: *270 headers: Link: *66 '304': *35 @@ -110316,16 +113186,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-user parameters: - - *267 + - *271 - *70 responses: '200': description: Response content: application/json: - schema: *265 + schema: *269 examples: - default: *266 + default: *270 headers: Link: *66 '304': *35 @@ -110347,7 +113217,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user parameters: - - *267 + - *271 - *70 - *17 - *45 @@ -110359,9 +113229,9 @@ paths: application/json: schema: type: array - items: *270 + items: *274 examples: - default: *694 + default: *699 headers: Link: *66 '304': *35 @@ -110383,7 +113253,7 @@ paths: url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project parameters: - *70 - - *267 + - *271 requestBody: required: true content: @@ -110421,7 +113291,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *695 + items: *700 required: - name - data_type @@ -110437,7 +113307,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *696 + iteration_configuration: *701 required: - name - data_type @@ -110459,20 +113329,20 @@ paths: value: name: Due date data_type: date - single_select_field: *697 - iteration_field: *698 + single_select_field: *702 + iteration_field: *703 responses: '201': description: Response content: application/json: - schema: *270 + schema: *274 examples: - text_field: *699 - number_field: *700 - date_field: *701 - single_select_field: *702 - iteration_field: *703 + text_field: *704 + number_field: *705 + date_field: *706 + single_select_field: *707 + iteration_field: *708 '304': *35 '403': *27 '401': *23 @@ -110493,17 +113363,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - - *267 - - *704 + - *271 + - *709 - *70 responses: '200': description: Response content: application/json: - schema: *270 + schema: *274 examples: - default: *705 + default: *710 headers: Link: *66 '304': *35 @@ -110526,7 +113396,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project parameters: - - *267 + - *271 - *70 - *45 - *46 @@ -110559,9 +113429,9 @@ paths: application/json: schema: type: array - items: *274 + items: *278 examples: - default: *275 + default: *279 headers: Link: *66 '304': *35 @@ -110583,7 +113453,7 @@ paths: url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project parameters: - *70 - - *267 + - *271 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -110653,22 +113523,22 @@ paths: description: Response content: application/json: - schema: *272 + schema: *276 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *273 + value: *277 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *273 + value: *277 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *273 + value: *277 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *273 + value: *277 '304': *35 '403': *27 '401': *23 @@ -110688,9 +113558,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *267 + - *271 - *70 - - *276 + - *280 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -110710,9 +113580,9 @@ paths: description: Response content: application/json: - schema: *274 + schema: *278 examples: - default: *275 + default: *279 headers: Link: *66 '304': *35 @@ -110733,9 +113603,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-user parameters: - - *267 + - *271 - *70 - - *276 + - *280 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -110808,13 +113678,13 @@ paths: description: Response content: application/json: - schema: *274 + schema: *278 examples: - text_field: *275 - number_field: *275 - date_field: *275 - single_select_field: *275 - iteration_field: *275 + text_field: *279 + number_field: *279 + date_field: *279 + single_select_field: *279 + iteration_field: *279 '401': *23 '403': *27 '404': *6 @@ -110834,9 +113704,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-user parameters: - - *267 + - *271 - *70 - - *276 + - *280 responses: '204': description: Response @@ -110858,9 +113728,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-project-view parameters: - - *267 + - *271 - *70 - - *706 + - *711 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -110886,9 +113756,9 @@ paths: application/json: schema: type: array - items: *274 + items: *278 examples: - default: *275 + default: *279 headers: Link: *66 '304': *35 @@ -111109,7 +113979,7 @@ paths: type: array items: *153 examples: - default: *262 + default: *266 headers: Link: *66 x-github: @@ -111135,7 +114005,7 @@ paths: - *116 - *118 - *117 - - *707 + - *712 - *119 responses: '200': @@ -111266,7 +114136,7 @@ paths: parameters: - *70 - *116 - - *708 + - *713 - *117 responses: '200': @@ -111365,9 +114235,9 @@ paths: - *116 - *118 - *117 - - *709 + - *714 - *119 - - *710 + - *715 responses: '200': description: Response when getting a billing usage summary @@ -111501,9 +114371,9 @@ paths: application/json: schema: type: array - items: *677 + items: *681 examples: - default: *678 + default: *682 headers: Link: *66 x-github: @@ -111533,9 +114403,9 @@ paths: application/json: schema: type: array - items: *679 + items: *683 examples: - default: *711 + default: *716 headers: Link: *66 x-github: @@ -111560,7 +114430,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *70 - - *712 + - *717 - *60 - *17 - *19 @@ -111572,11 +114442,11 @@ paths: schema: anyOf: - type: array - items: *713 + items: *718 - type: array items: *78 examples: - default-response: *682 + default-response: *686 headers: Link: *66 x-github: @@ -111607,7 +114477,7 @@ paths: type: array items: *153 examples: - default: *262 + default: *266 headers: Link: *66 x-github: @@ -111736,7 +114606,7 @@ webhooks: type: string enum: - disabled - enterprise: &714 + enterprise: &719 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -111805,7 +114675,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &715 + installation: &720 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -111826,7 +114696,7 @@ webhooks: required: - id - node_id - organization: &716 + organization: &721 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -111899,7 +114769,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &717 + repository: &722 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -112814,10 +115684,10 @@ webhooks: type: string enum: - enabled - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -112893,11 +115763,11 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - rule: &718 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + rule: &723 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -113120,11 +115990,11 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - rule: *718 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + rule: *723 sender: *4 required: - action @@ -113312,11 +116182,11 @@ webhooks: - everyone required: - from - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - rule: *718 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + rule: *723 sender: *4 required: - action @@ -113400,7 +116270,7 @@ webhooks: type: string enum: - completed - check_run: &720 + check_run: &725 title: CheckRun description: A check performed on the code of a given code change type: object @@ -113510,7 +116380,7 @@ webhooks: - examples: - neutral - deployment: *719 + deployment: *724 details_url: type: string examples: @@ -113608,10 +116478,10 @@ webhooks: - output - app - pull_requests - installation: *715 - enterprise: *714 - organization: *716 - repository: *717 + installation: *720 + enterprise: *719 + organization: *721 + repository: *722 sender: *4 required: - check_run @@ -114002,11 +116872,11 @@ webhooks: type: string enum: - created - check_run: *720 - installation: *715 - enterprise: *714 - organization: *716 - repository: *717 + check_run: *725 + installation: *720 + enterprise: *719 + organization: *721 + repository: *722 sender: *4 required: - check_run @@ -114400,11 +117270,11 @@ webhooks: type: string enum: - requested_action - check_run: *720 - installation: *715 - enterprise: *714 - organization: *716 - repository: *717 + check_run: *725 + installation: *720 + enterprise: *719 + organization: *721 + repository: *722 requested_action: description: The action requested by the user. type: object @@ -114807,11 +117677,11 @@ webhooks: type: string enum: - rerequested - check_run: *720 - installation: *715 - enterprise: *714 - organization: *716 - repository: *717 + check_run: *725 + installation: *720 + enterprise: *719 + organization: *721 + repository: *722 sender: *4 required: - check_run @@ -115796,10 +118666,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -116503,10 +119373,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -117204,10 +120074,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -117376,7 +120246,7 @@ webhooks: required: - login - id - dismissed_comment: *419 + dismissed_comment: *423 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -117528,20 +120398,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &721 + commit_oid: &726 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *714 - installation: *715 - organization: *716 - ref: &722 + enterprise: *719 + installation: *720 + organization: *721 + ref: &727 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *717 + repository: *722 sender: *4 required: - action @@ -117708,7 +120578,7 @@ webhooks: required: - login - id - dismissed_comment: *419 + dismissed_comment: *423 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -117949,12 +120819,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *721 - enterprise: *714 - installation: *715 - organization: *716 - ref: *722 - repository: *717 + commit_oid: *726 + enterprise: *719 + installation: *720 + organization: *721 + ref: *727 + repository: *722 sender: *4 required: - action @@ -118052,7 +120922,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *419 + dismissed_comment: *423 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -118237,12 +121107,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *721 - enterprise: *714 - installation: *715 - organization: *716 - ref: *722 - repository: *717 + commit_oid: *726 + enterprise: *719 + installation: *720 + organization: *721 + ref: *727 + repository: *722 sender: *4 required: - action @@ -118411,7 +121281,7 @@ webhooks: required: - login - id - dismissed_comment: *419 + dismissed_comment: *423 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -118588,12 +121458,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *721 - enterprise: *714 - installation: *715 - organization: *716 - ref: *722 - repository: *717 + commit_oid: *726 + enterprise: *719 + installation: *720 + organization: *721 + ref: *727 + repository: *722 sender: *4 required: - action @@ -118694,7 +121564,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *419 + dismissed_comment: *423 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -118883,9 +121753,9 @@ webhooks: type: - string - 'null' - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -118893,7 +121763,7 @@ webhooks: type: - string - 'null' - repository: *717 + repository: *722 sender: *4 required: - action @@ -118992,7 +121862,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *419 + dismissed_comment: *423 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -119139,12 +122009,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *721 - enterprise: *714 - installation: *715 - organization: *716 - ref: *722 - repository: *717 + commit_oid: *726 + enterprise: *719 + installation: *720 + organization: *721 + ref: *727 + repository: *722 sender: *4 required: - action @@ -119313,7 +122183,7 @@ webhooks: required: - login - id - dismissed_comment: *419 + dismissed_comment: *423 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -119465,10 +122335,10 @@ webhooks: - dismissed_reason - rule - tool - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -119728,10 +122598,10 @@ webhooks: - updated_at - author_association - body - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -119812,18 +122682,18 @@ webhooks: type: - string - 'null' - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *716 - pusher_type: &723 + organization: *721 + pusher_type: &728 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &724 + ref: &729 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -119833,7 +122703,7 @@ webhooks: enum: - tag - branch - repository: *717 + repository: *722 sender: *4 required: - ref @@ -119915,10 +122785,10 @@ webhooks: type: string enum: - created - definition: *278 - enterprise: *714 - installation: *715 - organization: *716 + definition: *282 + enterprise: *719 + installation: *720 + organization: *721 sender: *4 required: - action @@ -120003,9 +122873,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 sender: *4 required: - action @@ -120082,10 +122952,10 @@ webhooks: type: string enum: - promote_to_enterprise - definition: *278 - enterprise: *714 - installation: *715 - organization: *716 + definition: *282 + enterprise: *719 + installation: *720 + organization: *721 sender: *4 required: - action @@ -120162,10 +123032,10 @@ webhooks: type: string enum: - updated - definition: *278 - enterprise: *714 - installation: *715 - organization: *716 + definition: *282 + enterprise: *719 + installation: *720 + organization: *721 sender: *4 required: - action @@ -120242,19 +123112,19 @@ webhooks: type: string enum: - updated - enterprise: *714 - installation: *715 - repository: *717 - organization: *716 + enterprise: *719 + installation: *720 + repository: *722 + organization: *721 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *282 + items: *286 old_property_values: type: array description: The old custom property values for the repository. - items: *282 + items: *286 required: - action - repository @@ -120330,18 +123200,18 @@ webhooks: title: delete event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 - pusher_type: *723 - ref: *724 + enterprise: *719 + installation: *720 + organization: *721 + pusher_type: *728 + ref: *729 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *717 + repository: *722 sender: *4 required: - ref @@ -120421,11 +123291,11 @@ webhooks: type: string enum: - assignees_changed - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -120505,11 +123375,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -120590,11 +123460,11 @@ webhooks: type: string enum: - auto_reopened - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -120675,11 +123545,11 @@ webhooks: type: string enum: - created - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -120758,11 +123628,11 @@ webhooks: type: string enum: - dismissed - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -120841,11 +123711,11 @@ webhooks: type: string enum: - fixed - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -120925,11 +123795,11 @@ webhooks: type: string enum: - reintroduced - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -121008,11 +123878,11 @@ webhooks: type: string enum: - reopened - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -121089,9 +123959,9 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - key: &725 + enterprise: *719 + installation: *720 + key: &730 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -121129,8 +123999,8 @@ webhooks: - verified - created_at - read_only - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -121207,11 +124077,11 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - key: *725 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + key: *730 + organization: *721 + repository: *722 sender: *4 required: - action @@ -121778,12 +124648,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - workflow: &729 + workflow: &734 title: Workflow type: - object @@ -122534,13 +125404,13 @@ webhooks: deployment: anyOf: - type: 'null' - - *486 + - *490 pull_requests: type: array - items: *571 - repository: *717 - organization: *716 - installation: *715 + items: *575 + repository: *722 + organization: *721 + installation: *720 sender: *4 responses: '200': @@ -122611,7 +125481,7 @@ webhooks: type: string enum: - approved - approver: &726 + approver: &731 type: object properties: avatar_url: @@ -122654,11 +125524,11 @@ webhooks: type: string comment: type: string - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - reviewers: &727 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + reviewers: &732 type: array items: type: object @@ -122739,7 +125609,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &728 + workflow_job_run: &733 type: object properties: conclusion: @@ -123485,18 +126355,18 @@ webhooks: type: string enum: - rejected - approver: *726 + approver: *731 comment: type: string - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - reviewers: *727 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + reviewers: *732 sender: *4 since: type: string - workflow_job_run: *728 + workflow_job_run: *733 workflow_job_runs: type: array items: @@ -124213,13 +127083,13 @@ webhooks: type: string enum: - requested - enterprise: *714 + enterprise: *719 environment: type: string - installation: *715 - organization: *716 - repository: *717 - requestor: &734 + installation: *720 + organization: *721 + repository: *722 + requestor: &739 title: User type: - object @@ -126152,12 +129022,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - workflow: *729 + workflow: *734 workflow_run: title: Deployment Workflow Run type: @@ -126848,7 +129718,7 @@ webhooks: type: string enum: - answered - answer: &732 + answer: &737 type: object properties: author_association: @@ -127008,11 +129878,11 @@ webhooks: - created_at - updated_at - body - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -127139,11 +130009,11 @@ webhooks: - from required: - category - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -127226,11 +130096,11 @@ webhooks: type: string enum: - closed - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -127312,7 +130182,7 @@ webhooks: type: string enum: - created - comment: &731 + comment: &736 type: object properties: author_association: @@ -127472,11 +130342,11 @@ webhooks: - updated_at - body - reactions - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -127559,12 +130429,12 @@ webhooks: type: string enum: - deleted - comment: *731 - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + comment: *736 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -127659,12 +130529,12 @@ webhooks: - from required: - body - comment: *731 - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + comment: *736 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -127748,11 +130618,11 @@ webhooks: type: string enum: - created - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -127834,11 +130704,11 @@ webhooks: type: string enum: - deleted - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -127938,11 +130808,11 @@ webhooks: type: string required: - from - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128024,10 +130894,10 @@ webhooks: type: string enum: - labeled - discussion: *730 - enterprise: *714 - installation: *715 - label: &733 + discussion: *735 + enterprise: *719 + installation: *720 + label: &738 title: Label type: object properties: @@ -128060,8 +130930,8 @@ webhooks: - color - default - description - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128144,11 +131014,11 @@ webhooks: type: string enum: - locked - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128230,11 +131100,11 @@ webhooks: type: string enum: - pinned - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128316,11 +131186,11 @@ webhooks: type: string enum: - reopened - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128405,16 +131275,16 @@ webhooks: changes: type: object properties: - new_discussion: *730 - new_repository: *717 + new_discussion: *735 + new_repository: *722 required: - new_discussion - new_repository - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128497,10 +131367,10 @@ webhooks: type: string enum: - unanswered - discussion: *730 - old_answer: *732 - organization: *716 - repository: *717 + discussion: *735 + old_answer: *737 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128582,12 +131452,12 @@ webhooks: type: string enum: - unlabeled - discussion: *730 - enterprise: *714 - installation: *715 - label: *733 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + label: *738 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128670,11 +131540,11 @@ webhooks: type: string enum: - unlocked - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128756,11 +131626,11 @@ webhooks: type: string enum: - unpinned - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128833,7 +131703,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *714 + enterprise: *719 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -129511,9 +132381,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - forkee @@ -129659,9 +132529,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pages: description: The pages that were updated. type: array @@ -129699,7 +132569,7 @@ webhooks: - action - sha - html_url - repository: *717 + repository: *722 sender: *4 required: - pages @@ -129775,10 +132645,10 @@ webhooks: type: string enum: - created - enterprise: *714 + enterprise: *719 installation: *20 - organization: *716 - repositories: &735 + organization: *721 + repositories: &740 description: An array of repository objects that the installation can access. type: array @@ -129804,8 +132674,8 @@ webhooks: - name - full_name - private - repository: *717 - requester: *734 + repository: *722 + requester: *739 sender: *4 required: - action @@ -129880,11 +132750,11 @@ webhooks: type: string enum: - deleted - enterprise: *714 + enterprise: *719 installation: *20 - organization: *716 - repositories: *735 - repository: *717 + organization: *721 + repositories: *740 + repository: *722 requester: type: - 'null' @@ -129961,11 +132831,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *714 + enterprise: *719 installation: *20 - organization: *716 - repositories: *735 - repository: *717 + organization: *721 + repositories: *740 + repository: *722 requester: type: - 'null' @@ -130042,10 +132912,10 @@ webhooks: type: string enum: - added - enterprise: *714 + enterprise: *719 installation: *20 - organization: *716 - repositories_added: &736 + organization: *721 + repositories_added: &741 description: An array of repository objects, which were added to the installation. type: array @@ -130091,15 +132961,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *717 - repository_selection: &737 + repository: *722 + repository_selection: &742 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *734 + requester: *739 sender: *4 required: - action @@ -130178,10 +133048,10 @@ webhooks: type: string enum: - removed - enterprise: *714 + enterprise: *719 installation: *20 - organization: *716 - repositories_added: *736 + organization: *721 + repositories_added: *741 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -130208,9 +133078,9 @@ webhooks: - name - full_name - private - repository: *717 - repository_selection: *737 - requester: *734 + repository: *722 + repository_selection: *742 + requester: *739 sender: *4 required: - action @@ -130289,11 +133159,11 @@ webhooks: type: string enum: - suspend - enterprise: *714 + enterprise: *719 installation: *20 - organization: *716 - repositories: *735 - repository: *717 + organization: *721 + repositories: *740 + repository: *722 requester: type: - 'null' @@ -130475,10 +133345,10 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 target_type: type: string @@ -130557,11 +133427,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *714 + enterprise: *719 installation: *20 - organization: *716 - repositories: *735 - repository: *717 + organization: *721 + repositories: *740 + repository: *722 requester: type: - 'null' @@ -130727,7 +133597,7 @@ webhooks: pin: anyOf: - type: 'null' - - *550 + - *554 user: title: User type: @@ -130813,8 +133683,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -131626,8 +134496,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131644,7 +134514,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -131988,8 +134858,8 @@ webhooks: - state - locked - assignee - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -132069,7 +134939,7 @@ webhooks: type: string enum: - deleted - comment: &738 + comment: &743 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -132226,7 +135096,7 @@ webhooks: pin: anyOf: - type: 'null' - - *550 + - *554 required: - url - html_url @@ -132240,8 +135110,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -133049,8 +135919,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133067,7 +135937,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -133413,8 +136283,8 @@ webhooks: - state - locked - assignee - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -133494,7 +136364,7 @@ webhooks: type: string enum: - edited - changes: &762 + changes: &767 description: The changes to the comment. type: object properties: @@ -133506,9 +136376,9 @@ webhooks: type: string required: - from - comment: *738 - enterprise: *714 - installation: *715 + comment: *743 + enterprise: *719 + installation: *720 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -134319,8 +137189,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134337,7 +137207,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -134681,8 +137551,8 @@ webhooks: - state - locked - assignee - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -134763,9 +137633,9 @@ webhooks: type: string enum: - pinned - comment: *738 - enterprise: *714 - installation: *715 + comment: *743 + enterprise: *719 + installation: *720 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -135578,8 +138448,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135596,7 +138466,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -135942,8 +138812,8 @@ webhooks: - state - locked - assignee - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -136023,9 +138893,9 @@ webhooks: type: string enum: - unpinned - comment: *738 - enterprise: *714 - installation: *715 + comment: *743 + enterprise: *719 + installation: *720 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -136838,8 +139708,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136856,7 +139726,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -137202,8 +140072,8 @@ webhooks: - state - locked - assignee - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -137292,9 +140162,9 @@ webhooks: type: number blocking_issue: *82 blocking_issue_repo: *78 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -137383,9 +140253,9 @@ webhooks: type: number blocking_issue: *82 blocking_issue_repo: *78 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -137473,9 +140343,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -137564,9 +140434,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -137646,10 +140516,10 @@ webhooks: type: string enum: - assigned - assignee: *734 - enterprise: *714 - installation: *715 - issue: &739 + assignee: *739 + enterprise: *719 + installation: *720 + issue: &744 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -138460,11 +141330,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138481,7 +141351,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -138584,8 +141454,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -138665,8 +141535,8 @@ webhooks: type: string enum: - closed - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -139482,11 +142352,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139503,7 +142373,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -139749,8 +142619,8 @@ webhooks: required: - state - closed_at - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -139829,8 +142699,8 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -140637,11 +143507,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140658,7 +143528,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -140760,8 +143630,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -140840,8 +143710,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141671,11 +144541,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141692,7 +144562,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -141773,7 +144643,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &740 + milestone: &745 title: Milestone description: A collection of related issues and pull requests. type: object @@ -141916,8 +144786,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -142016,8 +144886,8 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -142828,11 +145698,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142846,7 +145716,7 @@ webhooks: timeline_url: type: string format: uri - type: *232 + type: *236 title: description: Title of the issue type: string @@ -142952,9 +145822,9 @@ webhooks: - active_lock_reason - body - reactions - label: *733 - organization: *716 - repository: *717 + label: *738 + organization: *721 + repository: *722 sender: *4 required: - action @@ -143034,9 +145904,9 @@ webhooks: type: string enum: - field_added - enterprise: *714 - installation: *715 - issue: *739 + enterprise: *719 + installation: *720 + issue: *744 issue_field: type: object description: The issue field whose value was set or updated on the @@ -143155,8 +146025,8 @@ webhooks: - id required: - from - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -143236,9 +146106,9 @@ webhooks: type: string enum: - field_removed - enterprise: *714 - installation: *715 - issue: *739 + enterprise: *719 + installation: *720 + issue: *744 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -143301,8 +146171,8 @@ webhooks: - 'null' required: - id - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -143382,8 +146252,8 @@ webhooks: type: string enum: - labeled - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144193,11 +147063,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144211,7 +147081,7 @@ webhooks: timeline_url: type: string format: uri - type: *232 + type: *236 title: description: Title of the issue type: string @@ -144317,9 +147187,9 @@ webhooks: - active_lock_reason - body - reactions - label: *733 - organization: *716 - repository: *717 + label: *738 + organization: *721 + repository: *722 sender: *4 required: - action @@ -144399,8 +147269,8 @@ webhooks: type: string enum: - locked - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -145235,11 +148105,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145253,7 +148123,7 @@ webhooks: timeline_url: type: string format: uri - type: *232 + type: *236 title: description: Title of the issue type: string @@ -145336,8 +148206,8 @@ webhooks: format: uri user_view_type: type: string - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -145416,8 +148286,8 @@ webhooks: type: string enum: - milestoned - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -146246,11 +149116,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146267,7 +149137,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -146347,9 +149217,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *740 - organization: *716 - repository: *717 + milestone: *745 + organization: *721 + repository: *722 sender: *4 required: - action @@ -147236,11 +150106,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147340,7 +150210,7 @@ webhooks: required: - login - id - type: *232 + type: *236 required: - id - number @@ -147832,8 +150702,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -148640,11 +151510,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148661,7 +151531,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -148767,8 +151637,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -148848,9 +151718,9 @@ webhooks: type: string enum: - pinned - enterprise: *714 - installation: *715 - issue: &741 + enterprise: *719 + installation: *720 + issue: &746 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -149655,11 +152525,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149676,7 +152546,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -149778,8 +152648,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -149858,8 +152728,8 @@ webhooks: type: string enum: - reopened - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -150692,11 +153562,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150793,9 +153663,9 @@ webhooks: format: uri user_view_type: type: string - type: *232 - organization: *716 - repository: *717 + type: *236 + organization: *721 + repository: *722 sender: *4 required: - action @@ -151683,11 +154553,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151704,7 +154574,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -152297,11 +155167,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *714 - installation: *715 - issue: *741 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + issue: *746 + organization: *721 + repository: *722 sender: *4 required: - action @@ -152381,12 +155251,12 @@ webhooks: type: string enum: - typed - enterprise: *714 - installation: *715 - issue: *739 - type: *232 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + issue: *744 + type: *236 + organization: *721 + repository: *722 sender: *4 required: - action @@ -152467,7 +155337,7 @@ webhooks: type: string enum: - unassigned - assignee: &765 + assignee: &770 title: User type: - object @@ -152539,11 +155409,11 @@ webhooks: required: - login - id - enterprise: *714 - installation: *715 - issue: *739 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + issue: *744 + organization: *721 + repository: *722 sender: *4 required: - action @@ -152622,12 +155492,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *714 - installation: *715 - issue: *739 - label: *733 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + issue: *744 + label: *738 + organization: *721 + repository: *722 sender: *4 required: - action @@ -152707,8 +155577,8 @@ webhooks: type: string enum: - unlocked - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -153541,11 +156411,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153562,7 +156432,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -153642,8 +156512,8 @@ webhooks: format: uri user_view_type: type: string - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -153723,11 +156593,11 @@ webhooks: type: string enum: - unpinned - enterprise: *714 - installation: *715 - issue: *741 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + issue: *746 + organization: *721 + repository: *722 sender: *4 required: - action @@ -153806,12 +156676,12 @@ webhooks: type: string enum: - untyped - enterprise: *714 - installation: *715 - issue: *739 - type: *232 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + issue: *744 + type: *236 + organization: *721 + repository: *722 sender: *4 required: - action @@ -153891,11 +156761,11 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - label: *733 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + label: *738 + organization: *721 + repository: *722 sender: *4 required: - action @@ -153973,11 +156843,11 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - label: *733 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + label: *738 + organization: *721 + repository: *722 sender: *4 required: - action @@ -154087,11 +156957,11 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - label: *733 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + label: *738 + organization: *721 + repository: *722 sender: *4 required: - action @@ -154173,9 +157043,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *714 - installation: *715 - marketplace_purchase: &742 + enterprise: *719 + installation: *720 + marketplace_purchase: &747 title: Marketplace Purchase type: object required: @@ -154263,8 +157133,8 @@ webhooks: type: integer unit_count: type: integer - organization: *716 - previous_marketplace_purchase: &743 + organization: *721 + previous_marketplace_purchase: &748 title: Marketplace Purchase type: object properties: @@ -154348,7 +157218,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *717 + repository: *722 sender: *4 required: - action @@ -154428,10 +157298,10 @@ webhooks: - changed effective_date: type: string - enterprise: *714 - installation: *715 - marketplace_purchase: *742 - organization: *716 + enterprise: *719 + installation: *720 + marketplace_purchase: *747 + organization: *721 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -154519,7 +157389,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *717 + repository: *722 sender: *4 required: - action @@ -154601,10 +157471,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *714 - installation: *715 - marketplace_purchase: *742 - organization: *716 + enterprise: *719 + installation: *720 + marketplace_purchase: *747 + organization: *721 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -154690,7 +157560,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *717 + repository: *722 sender: *4 required: - action @@ -154771,8 +157641,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 marketplace_purchase: title: Marketplace Purchase type: object @@ -154858,9 +157728,9 @@ webhooks: type: integer unit_count: type: integer - organization: *716 - previous_marketplace_purchase: *743 - repository: *717 + organization: *721 + previous_marketplace_purchase: *748 + repository: *722 sender: *4 required: - action @@ -154940,12 +157810,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *714 - installation: *715 - marketplace_purchase: *742 - organization: *716 - previous_marketplace_purchase: *743 - repository: *717 + enterprise: *719 + installation: *720 + marketplace_purchase: *747 + organization: *721 + previous_marketplace_purchase: *748 + repository: *722 sender: *4 required: - action @@ -155047,11 +157917,11 @@ webhooks: type: string required: - to - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + member: *739 + organization: *721 + repository: *722 sender: *4 required: - action @@ -155153,11 +158023,11 @@ webhooks: type: - string - 'null' - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + member: *739 + organization: *721 + repository: *722 sender: *4 required: - action @@ -155236,11 +158106,11 @@ webhooks: type: string enum: - removed - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + member: *739 + organization: *721 + repository: *722 sender: *4 required: - action @@ -155318,11 +158188,11 @@ webhooks: type: string enum: - added - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + member: *739 + organization: *721 + repository: *722 scope: description: The scope of the membership. Currently, can only be `team`. @@ -155400,7 +158270,7 @@ webhooks: required: - login - id - team: &744 + team: &749 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -155630,11 +158500,11 @@ webhooks: type: string enum: - removed - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + member: *739 + organization: *721 + repository: *722 scope: description: The scope of the membership. Currently, can only be `team`. @@ -155713,7 +158583,7 @@ webhooks: required: - login - id - team: *744 + team: *749 required: - action - scope @@ -155795,8 +158665,8 @@ webhooks: type: string enum: - checks_requested - installation: *715 - merge_group: &745 + installation: *720 + merge_group: &750 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -155815,15 +158685,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *408 + head_commit: *412 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -155909,10 +158779,10 @@ webhooks: - merged - invalidated - dequeued - installation: *715 - merge_group: *745 - organization: *716 - repository: *717 + installation: *720 + merge_group: *750 + organization: *721 + repository: *722 sender: *4 required: - action @@ -155985,7 +158855,7 @@ webhooks: type: string enum: - deleted - enterprise: *714 + enterprise: *719 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -156094,12 +158964,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *715 - organization: *716 + installation: *720 + organization: *721 repository: anyOf: - type: 'null' - - *717 + - *722 sender: *4 required: - action @@ -156179,11 +159049,11 @@ webhooks: type: string enum: - closed - enterprise: *714 - installation: *715 - milestone: *740 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + milestone: *745 + organization: *721 + repository: *722 sender: *4 required: - action @@ -156262,9 +159132,9 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - milestone: &746 + enterprise: *719 + installation: *720 + milestone: &751 title: Milestone description: A collection of related issues and pull requests. type: object @@ -156406,8 +159276,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -156486,11 +159356,11 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - milestone: *740 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + milestone: *745 + organization: *721 + repository: *722 sender: *4 required: - action @@ -156600,11 +159470,11 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - milestone: *740 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + milestone: *745 + organization: *721 + repository: *722 sender: *4 required: - action @@ -156684,11 +159554,11 @@ webhooks: type: string enum: - opened - enterprise: *714 - installation: *715 - milestone: *746 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + milestone: *751 + organization: *721 + repository: *722 sender: *4 required: - action @@ -156767,11 +159637,11 @@ webhooks: type: string enum: - blocked - blocked_user: *734 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + blocked_user: *739 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -156850,11 +159720,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *734 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + blocked_user: *739 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -156933,9 +159803,9 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - membership: &747 + enterprise: *719 + installation: *720 + membership: &752 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -157045,8 +159915,8 @@ webhooks: - role - organization_url - user - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -157124,11 +159994,11 @@ webhooks: type: string enum: - member_added - enterprise: *714 - installation: *715 - membership: *747 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + membership: *752 + organization: *721 + repository: *722 sender: *4 required: - action @@ -157207,8 +160077,8 @@ webhooks: type: string enum: - member_invited - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -157330,10 +160200,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 - user: *734 + user: *739 required: - action - invitation @@ -157411,11 +160281,11 @@ webhooks: type: string enum: - member_removed - enterprise: *714 - installation: *715 - membership: *747 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + membership: *752 + organization: *721 + repository: *722 sender: *4 required: - action @@ -157502,11 +160372,11 @@ webhooks: properties: from: type: string - enterprise: *714 - installation: *715 - membership: *747 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + membership: *752 + organization: *721 + repository: *722 sender: *4 required: - action @@ -157583,9 +160453,9 @@ webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 package: description: Information about the package. type: object @@ -158108,7 +160978,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &748 + items: &753 title: Ruby Gems metadata type: object properties: @@ -158205,7 +161075,7 @@ webhooks: - owner - package_version - registry - repository: *717 + repository: *722 sender: *4 required: - action @@ -158281,9 +161151,9 @@ webhooks: type: string enum: - updated - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 package: description: Information about the package. type: object @@ -158645,7 +161515,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *748 + items: *753 source_url: type: string format: uri @@ -158716,7 +161586,7 @@ webhooks: - owner - package_version - registry - repository: *717 + repository: *722 sender: *4 required: - action @@ -158896,12 +161766,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *714 + enterprise: *719 id: type: integer - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - id @@ -158978,7 +161848,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &749 + personal_access_token_request: &754 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -159128,10 +161998,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *714 - organization: *716 + enterprise: *719 + organization: *721 sender: *4 - installation: *715 + installation: *720 required: - action - personal_access_token_request @@ -159208,11 +162078,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *749 - enterprise: *714 - organization: *716 + personal_access_token_request: *754 + enterprise: *719 + organization: *721 sender: *4 - installation: *715 + installation: *720 required: - action - personal_access_token_request @@ -159288,11 +162158,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *749 - enterprise: *714 - organization: *716 + personal_access_token_request: *754 + enterprise: *719 + organization: *721 sender: *4 - installation: *715 + installation: *720 required: - action - personal_access_token_request @@ -159367,11 +162237,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *749 - organization: *716 - enterprise: *714 + personal_access_token_request: *754 + organization: *721 + enterprise: *719 sender: *4 - installation: *715 + installation: *720 required: - action - personal_access_token_request @@ -159476,7 +162346,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *750 + last_response: *755 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -159508,8 +162378,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 zen: description: Random string of GitHub zen. @@ -159754,10 +162624,10 @@ webhooks: - from required: - note - enterprise: *714 - installation: *715 - organization: *716 - project_card: &751 + enterprise: *719 + installation: *720 + organization: *721 + project_card: &756 title: Project Card type: object properties: @@ -159880,7 +162750,7 @@ webhooks: - creator - created_at - updated_at - repository: *717 + repository: *722 sender: *4 required: - action @@ -159961,11 +162831,11 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - project_card: *751 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + project_card: *756 + repository: *722 sender: *4 required: - action @@ -160045,9 +162915,9 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 project_card: title: Project Card type: object @@ -160177,7 +163047,7 @@ webhooks: repository: anyOf: - type: 'null' - - *717 + - *722 sender: *4 required: - action @@ -160271,11 +163141,11 @@ webhooks: - from required: - note - enterprise: *714 - installation: *715 - organization: *716 - project_card: *751 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + project_card: *756 + repository: *722 sender: *4 required: - action @@ -160369,9 +163239,9 @@ webhooks: - from required: - column_id - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 project_card: allOf: - title: Project Card @@ -160568,7 +163438,7 @@ webhooks: type: string required: - after_id - repository: *717 + repository: *722 sender: *4 required: - action @@ -160648,10 +163518,10 @@ webhooks: type: string enum: - closed - enterprise: *714 - installation: *715 - organization: *716 - project: &753 + enterprise: *719 + installation: *720 + organization: *721 + project: &758 title: Project type: object properties: @@ -160778,7 +163648,7 @@ webhooks: - creator - created_at - updated_at - repository: *717 + repository: *722 sender: *4 required: - action @@ -160858,10 +163728,10 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - project_column: &752 + enterprise: *719 + installation: *720 + organization: *721 + project_column: &757 title: Project Column type: object properties: @@ -160901,7 +163771,7 @@ webhooks: - name - created_at - updated_at - repository: *717 + repository: *722 sender: *4 required: - action @@ -160980,14 +163850,14 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - project_column: *752 + enterprise: *719 + installation: *720 + organization: *721 + project_column: *757 repository: anyOf: - type: 'null' - - *717 + - *722 sender: *4 required: - action @@ -161076,11 +163946,11 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 - project_column: *752 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + project_column: *757 + repository: *722 sender: *4 required: - action @@ -161160,11 +164030,11 @@ webhooks: type: string enum: - moved - enterprise: *714 - installation: *715 - organization: *716 - project_column: *752 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + project_column: *757 + repository: *722 sender: *4 required: - action @@ -161244,11 +164114,11 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - project: *753 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + project: *758 + repository: *722 sender: *4 required: - action @@ -161328,14 +164198,14 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - project: *753 + enterprise: *719 + installation: *720 + organization: *721 + project: *758 repository: anyOf: - type: 'null' - - *717 + - *722 sender: *4 required: - action @@ -161436,11 +164306,11 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 - project: *753 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + project: *758 + repository: *722 sender: *4 required: - action @@ -161519,11 +164389,11 @@ webhooks: type: string enum: - reopened - enterprise: *714 - installation: *715 - organization: *716 - project: *753 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + project: *758 + repository: *722 sender: *4 required: - action @@ -161604,9 +164474,9 @@ webhooks: type: string enum: - closed - installation: *715 - organization: *716 - projects_v2: *265 + installation: *720 + organization: *721 + projects_v2: *269 sender: *4 required: - action @@ -161687,9 +164557,9 @@ webhooks: type: string enum: - created - installation: *715 - organization: *716 - projects_v2: *265 + installation: *720 + organization: *721 + projects_v2: *269 sender: *4 required: - action @@ -161770,9 +164640,9 @@ webhooks: type: string enum: - deleted - installation: *715 - organization: *716 - projects_v2: *265 + installation: *720 + organization: *721 + projects_v2: *269 sender: *4 required: - action @@ -161893,9 +164763,9 @@ webhooks: type: string to: type: string - installation: *715 - organization: *716 - projects_v2: *265 + installation: *720 + organization: *721 + projects_v2: *269 sender: *4 required: - action @@ -161978,7 +164848,7 @@ webhooks: type: string enum: - archived - changes: &757 + changes: &762 type: object properties: archived_at: @@ -161994,9 +164864,9 @@ webhooks: - string - 'null' format: date-time - installation: *715 - organization: *716 - projects_v2_item: &754 + installation: *720 + organization: *721 + projects_v2_item: &759 title: Projects v2 Item description: An item belonging to a project type: object @@ -162014,7 +164884,7 @@ webhooks: type: string description: The node ID of the content represented by this item. - content_type: *271 + content_type: *275 creator: *4 created_at: type: string @@ -162136,9 +165006,9 @@ webhooks: - 'null' to: type: string - installation: *715 - organization: *716 - projects_v2_item: *754 + installation: *720 + organization: *721 + projects_v2_item: *759 sender: *4 required: - action @@ -162220,9 +165090,9 @@ webhooks: type: string enum: - created - installation: *715 - organization: *716 - projects_v2_item: *754 + installation: *720 + organization: *721 + projects_v2_item: *759 sender: *4 required: - action @@ -162303,9 +165173,9 @@ webhooks: type: string enum: - deleted - installation: *715 - organization: *716 - projects_v2_item: *754 + installation: *720 + organization: *721 + projects_v2_item: *759 sender: *4 required: - action @@ -162410,7 +165280,7 @@ webhooks: oneOf: - type: string - type: integer - - &755 + - &760 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -162434,7 +165304,7 @@ webhooks: required: - id - name - - &756 + - &761 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -162474,8 +165344,8 @@ webhooks: oneOf: - type: string - type: integer - - *755 - - *756 + - *760 + - *761 type: - 'null' - string @@ -162498,9 +165368,9 @@ webhooks: - 'null' required: - body - installation: *715 - organization: *716 - projects_v2_item: *754 + installation: *720 + organization: *721 + projects_v2_item: *759 sender: *4 required: - action @@ -162597,9 +165467,9 @@ webhooks: type: - string - 'null' - installation: *715 - organization: *716 - projects_v2_item: *754 + installation: *720 + organization: *721 + projects_v2_item: *759 sender: *4 required: - action @@ -162682,10 +165552,10 @@ webhooks: type: string enum: - restored - changes: *757 - installation: *715 - organization: *716 - projects_v2_item: *754 + changes: *762 + installation: *720 + organization: *721 + projects_v2_item: *759 sender: *4 required: - action @@ -162767,9 +165637,9 @@ webhooks: type: string enum: - reopened - installation: *715 - organization: *716 - projects_v2: *265 + installation: *720 + organization: *721 + projects_v2: *269 sender: *4 required: - action @@ -162850,9 +165720,9 @@ webhooks: type: string enum: - created - installation: *715 - organization: *716 - projects_v2_status_update: *758 + installation: *720 + organization: *721 + projects_v2_status_update: *763 sender: *4 required: - action @@ -162933,9 +165803,9 @@ webhooks: type: string enum: - deleted - installation: *715 - organization: *716 - projects_v2_status_update: *758 + installation: *720 + organization: *721 + projects_v2_status_update: *763 sender: *4 required: - action @@ -163081,9 +165951,9 @@ webhooks: - string - 'null' format: date - installation: *715 - organization: *716 - projects_v2_status_update: *758 + installation: *720 + organization: *721 + projects_v2_status_update: *763 sender: *4 required: - action @@ -163154,10 +166024,10 @@ webhooks: title: public event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - repository @@ -163234,13 +166104,13 @@ webhooks: type: string enum: - assigned - assignee: *734 - enterprise: *714 - installation: *715 - number: &759 + assignee: *739 + enterprise: *719 + installation: *720 + number: &764 description: The pull request number. type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -165592,7 +168462,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -165674,11 +168544,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -168023,7 +170893,7 @@ webhooks: - draft reason: type: string - repository: *717 + repository: *722 sender: *4 required: - action @@ -168105,11 +170975,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -170454,7 +173324,7 @@ webhooks: - draft reason: type: string - repository: *717 + repository: *722 sender: *4 required: - action @@ -170536,13 +173406,13 @@ webhooks: type: string enum: - closed - enterprise: *714 - installation: *715 - number: *759 - organization: *716 - pull_request: &760 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 + pull_request: &765 allOf: - - *571 + - *575 - type: object properties: allow_auto_merge: @@ -170604,7 +173474,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *717 + repository: *722 sender: *4 required: - action @@ -170685,12 +173555,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *714 - installation: *715 - number: *759 - organization: *716 - pull_request: *760 - repository: *717 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 + pull_request: *765 + repository: *722 sender: *4 required: - action @@ -170770,11 +173640,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *714 - milestone: *268 - number: *759 - organization: *716 - pull_request: &761 + enterprise: *719 + milestone: *272 + number: *764 + organization: *721 + pull_request: &766 title: Pull Request type: object properties: @@ -173118,7 +175988,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -173197,11 +176067,11 @@ webhooks: type: string enum: - dequeued - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -175564,7 +178434,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *717 + repository: *722 sender: *4 required: - action @@ -175688,12 +178558,12 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - number: *759 - organization: *716 - pull_request: *760 - repository: *717 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 + pull_request: *765 + repository: *722 sender: *4 required: - action @@ -175773,11 +178643,11 @@ webhooks: type: string enum: - enqueued - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -178125,7 +180995,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -178205,11 +181075,11 @@ webhooks: type: string enum: - labeled - enterprise: *714 - installation: *715 - label: *733 - number: *759 - organization: *716 + enterprise: *719 + installation: *720 + label: *738 + number: *764 + organization: *721 pull_request: title: Pull Request type: object @@ -180560,7 +183430,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -180641,10 +183511,10 @@ webhooks: type: string enum: - locked - enterprise: *714 - installation: *715 - number: *759 - organization: *716 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 pull_request: title: Pull Request type: object @@ -182993,7 +185863,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -183073,12 +185943,12 @@ webhooks: type: string enum: - milestoned - enterprise: *714 - milestone: *268 - number: *759 - organization: *716 - pull_request: *761 - repository: *717 + enterprise: *719 + milestone: *272 + number: *764 + organization: *721 + pull_request: *766 + repository: *722 sender: *4 required: - action @@ -183157,12 +186027,12 @@ webhooks: type: string enum: - opened - enterprise: *714 - installation: *715 - number: *759 - organization: *716 - pull_request: *760 - repository: *717 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 + pull_request: *765 + repository: *722 sender: *4 required: - action @@ -183243,12 +186113,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *714 - installation: *715 - number: *759 - organization: *716 - pull_request: *760 - repository: *717 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 + pull_request: *765 + repository: *722 sender: *4 required: - action @@ -183328,12 +186198,12 @@ webhooks: type: string enum: - reopened - enterprise: *714 - installation: *715 - number: *759 - organization: *716 - pull_request: *760 - repository: *717 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 + pull_request: *765 + repository: *722 sender: *4 required: - action @@ -183708,9 +186578,9 @@ webhooks: - start_side - side - reactions - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pull_request: type: object properties: @@ -185943,7 +188813,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *717 + repository: *722 sender: *4 required: - action @@ -186023,7 +188893,7 @@ webhooks: type: string enum: - deleted - comment: &763 + comment: &768 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -186316,9 +189186,9 @@ webhooks: - start_side - side - reactions - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pull_request: type: object properties: @@ -188539,7 +191409,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *717 + repository: *722 sender: *4 required: - action @@ -188619,11 +191489,11 @@ webhooks: type: string enum: - edited - changes: *762 - comment: *763 - enterprise: *714 - installation: *715 - organization: *716 + changes: *767 + comment: *768 + enterprise: *719 + installation: *720 + organization: *721 pull_request: type: object properties: @@ -190847,7 +193717,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *717 + repository: *722 sender: *4 required: - action @@ -190928,9 +193798,9 @@ webhooks: type: string enum: - dismissed - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pull_request: title: Simple Pull Request type: object @@ -193166,7 +196036,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 + repository: *722 review: description: The review that was affected. type: object @@ -193417,9 +196287,9 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pull_request: title: Simple Pull Request type: object @@ -195528,8 +198398,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 - review: &764 + repository: *722 + review: &769 description: The review that was affected. type: object properties: @@ -195767,12 +198637,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: description: The pull request number. type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -198122,7 +200992,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 requested_reviewer: title: User type: @@ -198208,12 +201078,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: description: The pull request number. type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -200570,7 +203440,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 requested_team: title: Team description: Groups of organization members that gives permissions @@ -200765,12 +203635,12 @@ webhooks: type: string enum: - review_requested - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: description: The pull request number. type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -203122,7 +205992,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 requested_reviewer: title: User type: @@ -203209,12 +206079,12 @@ webhooks: type: string enum: - review_requested - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: description: The pull request number. type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -205557,7 +208427,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 requested_team: title: Team description: Groups of organization members that gives permissions @@ -205741,9 +208611,9 @@ webhooks: type: string enum: - submitted - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pull_request: title: Simple Pull Request type: object @@ -207982,8 +210852,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 - review: *764 + repository: *722 + review: *769 sender: *4 required: - action @@ -208063,9 +210933,9 @@ webhooks: type: string enum: - resolved - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pull_request: title: Simple Pull Request type: object @@ -210213,7 +213083,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 + repository: *722 sender: *4 thread: type: object @@ -210610,9 +213480,9 @@ webhooks: type: string enum: - unresolved - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pull_request: title: Simple Pull Request type: object @@ -212743,7 +215613,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 + repository: *722 sender: *4 thread: type: object @@ -213142,10 +216012,10 @@ webhooks: type: string before: type: string - enterprise: *714 - installation: *715 - number: *759 - organization: *716 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 pull_request: title: Pull Request type: object @@ -215483,7 +218353,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -215565,11 +218435,11 @@ webhooks: type: string enum: - unassigned - assignee: *765 - enterprise: *714 - installation: *715 - number: *759 - organization: *716 + assignee: *770 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 pull_request: title: Pull Request type: object @@ -217922,7 +220792,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -218001,11 +220871,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *714 - installation: *715 - label: *733 - number: *759 - organization: *716 + enterprise: *719 + installation: *720 + label: *738 + number: *764 + organization: *721 pull_request: title: Pull Request type: object @@ -220347,7 +223217,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -220428,10 +223298,10 @@ webhooks: type: string enum: - unlocked - enterprise: *714 - installation: *715 - number: *759 - organization: *716 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 pull_request: title: Pull Request type: object @@ -222763,7 +225633,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -222966,7 +225836,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *714 + enterprise: *719 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -223061,8 +225931,8 @@ webhooks: - url - author - committer - installation: *715 - organization: *716 + installation: *720 + organization: *721 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -223661,9 +226531,9 @@ webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 registry_package: type: object properties: @@ -224140,7 +227010,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *748 + items: *753 summary: type: string tag_name: @@ -224196,7 +227066,7 @@ webhooks: - owner - package_version - registry - repository: *717 + repository: *722 sender: *4 required: - action @@ -224274,9 +227144,9 @@ webhooks: type: string enum: - updated - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 registry_package: type: object properties: @@ -224588,7 +227458,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *748 + items: *753 summary: type: string tag_name: @@ -224638,7 +227508,7 @@ webhooks: - owner - package_version - registry - repository: *717 + repository: *722 sender: *4 required: - action @@ -224715,10 +227585,10 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - release: &766 + enterprise: *719 + installation: *720 + organization: *721 + release: &771 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -225049,7 +227919,7 @@ webhooks: - updated_at - zipball_url - body - repository: *717 + repository: *722 sender: *4 required: - action @@ -225126,11 +227996,11 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - release: *766 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + release: *771 + repository: *722 sender: *4 required: - action @@ -225247,11 +228117,11 @@ webhooks: type: boolean required: - to - enterprise: *714 - installation: *715 - organization: *716 - release: *766 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + release: *771 + repository: *722 sender: *4 required: - action @@ -225329,9 +228199,9 @@ webhooks: type: string enum: - prereleased - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -225667,7 +228537,7 @@ webhooks: - string - 'null' format: uri - repository: *717 + repository: *722 sender: *4 required: - action @@ -225743,10 +228613,10 @@ webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 - release: &767 + enterprise: *719 + installation: *720 + organization: *721 + release: &772 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -226079,7 +228949,7 @@ webhooks: - string - 'null' format: uri - repository: *717 + repository: *722 sender: *4 required: - action @@ -226155,11 +229025,11 @@ webhooks: type: string enum: - released - enterprise: *714 - installation: *715 - organization: *716 - release: *766 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + release: *771 + repository: *722 sender: *4 required: - action @@ -226235,11 +229105,11 @@ webhooks: type: string enum: - unpublished - enterprise: *714 - installation: *715 - organization: *716 - release: *767 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + release: *772 + repository: *722 sender: *4 required: - action @@ -226315,11 +229185,11 @@ webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - repository_advisory: *638 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + repository_advisory: *642 sender: *4 required: - action @@ -226395,11 +229265,11 @@ webhooks: type: string enum: - reported - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - repository_advisory: *638 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + repository_advisory: *642 sender: *4 required: - action @@ -226475,10 +229345,10 @@ webhooks: type: string enum: - archived - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -226555,10 +229425,10 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -226636,10 +229506,10 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -226724,10 +229594,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -226842,10 +229712,10 @@ webhooks: - 'null' items: type: string - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -226917,10 +229787,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 status: type: string @@ -227001,10 +229871,10 @@ webhooks: type: string enum: - privatized - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -227081,10 +229951,10 @@ webhooks: type: string enum: - publicized - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -227178,10 +230048,10 @@ webhooks: - name required: - repository - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -227261,11 +230131,11 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - repository_ruleset: *310 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + repository_ruleset: *314 sender: *4 required: - action @@ -227343,11 +230213,11 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - repository_ruleset: *310 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + repository_ruleset: *314 sender: *4 required: - action @@ -227425,11 +230295,11 @@ webhooks: type: string enum: - edited - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - repository_ruleset: *310 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + repository_ruleset: *314 changes: type: object properties: @@ -227448,16 +230318,16 @@ webhooks: properties: added: type: array - items: *284 + items: *288 deleted: type: array - items: *284 + items: *288 updated: type: array items: type: object properties: - condition: *284 + condition: *288 changes: type: object properties: @@ -227490,16 +230360,16 @@ webhooks: properties: added: type: array - items: *591 + items: *595 deleted: type: array - items: *591 + items: *595 updated: type: array items: type: object properties: - rule: *591 + rule: *595 changes: type: object properties: @@ -227736,10 +230606,10 @@ webhooks: - from required: - owner - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -227817,10 +230687,10 @@ webhooks: type: string enum: - unarchived - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -227898,7 +230768,7 @@ webhooks: type: string enum: - create - alert: &768 + alert: &773 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -228023,10 +230893,10 @@ webhooks: enum: - auto_dismissed - open - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -228236,10 +231106,10 @@ webhooks: type: string enum: - dismissed - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -228317,11 +231187,11 @@ webhooks: type: string enum: - reopen - alert: *768 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *773 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -228523,10 +231393,10 @@ webhooks: enum: - fixed - open - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -228604,7 +231474,7 @@ webhooks: type: string enum: - assigned - alert: &769 + alert: &774 type: object properties: number: *171 @@ -228744,10 +231614,10 @@ webhooks: - type: 'null' - *4 assignee: *4 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -228825,11 +231695,11 @@ webhooks: type: string enum: - created - alert: *769 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *774 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -228910,11 +231780,11 @@ webhooks: type: string enum: - created - alert: *769 - installation: *715 - location: *770 - organization: *716 - repository: *717 + alert: *774 + installation: *720 + location: *775 + organization: *721 + repository: *722 sender: *4 required: - location @@ -229152,11 +232022,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *769 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *774 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -229234,11 +232104,11 @@ webhooks: type: string enum: - reopened - alert: *769 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *774 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -229316,11 +232186,11 @@ webhooks: type: string enum: - resolved - alert: *769 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *774 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -229398,12 +232268,12 @@ webhooks: type: string enum: - unassigned - alert: *769 + alert: *774 assignee: *4 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -229481,11 +232351,11 @@ webhooks: type: string enum: - validated - alert: *769 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *774 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -229615,10 +232485,10 @@ webhooks: - organization - enterprise - - repository: *717 - enterprise: *714 - installation: *715 - organization: *716 + repository: *722 + enterprise: *719 + installation: *720 + organization: *721 sender: *4 required: - action @@ -229696,11 +232566,11 @@ webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - security_advisory: &771 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + security_advisory: &776 description: The details of the security advisory, including summary, description, and severity. type: object @@ -229873,11 +232743,11 @@ webhooks: type: string enum: - updated - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - security_advisory: *771 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + security_advisory: *776 sender: *4 required: - action @@ -229950,10 +232820,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -230126,11 +232996,11 @@ webhooks: from: type: object properties: - security_and_analysis: *283 - enterprise: *714 - installation: *715 - organization: *716 - repository: *330 + security_and_analysis: *287 + enterprise: *719 + installation: *720 + organization: *721 + repository: *334 sender: *4 required: - changes @@ -230208,12 +233078,12 @@ webhooks: type: string enum: - cancelled - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - sponsorship: &772 + sponsorship: &777 type: object properties: created_at: @@ -230518,12 +233388,12 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - sponsorship: *772 + sponsorship: *777 required: - action - sponsorship @@ -230611,12 +233481,12 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - sponsorship: *772 + sponsorship: *777 required: - action - changes @@ -230693,17 +233563,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &773 + effective_date: &778 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - sponsorship: *772 + sponsorship: *777 required: - action - sponsorship @@ -230777,7 +233647,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &774 + changes: &779 type: object properties: tier: @@ -230821,13 +233691,13 @@ webhooks: - from required: - tier - effective_date: *773 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + effective_date: *778 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - sponsorship: *772 + sponsorship: *777 required: - action - changes @@ -230904,13 +233774,13 @@ webhooks: type: string enum: - tier_changed - changes: *774 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + changes: *779 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - sponsorship: *772 + sponsorship: *777 required: - action - changes @@ -230984,10 +233854,10 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -231071,10 +233941,10 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -231508,15 +234378,15 @@ webhooks: type: - string - 'null' - enterprise: *714 + enterprise: *719 id: description: The unique identifier of the status. type: integer - installation: *715 + installation: *720 name: type: string - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 sha: description: The Commit SHA. @@ -231632,9 +234502,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -231724,9 +234594,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -231816,9 +234686,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -231908,9 +234778,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -231987,12 +234857,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - team: &775 + team: &780 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -232222,9 +235092,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 repository: title: Repository description: A git repository @@ -232694,7 +235564,7 @@ webhooks: - topics - visibility sender: *4 - team: *775 + team: *780 required: - action - team @@ -232770,9 +235640,9 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 repository: title: Repository description: A git repository @@ -233242,7 +236112,7 @@ webhooks: - topics - visibility sender: *4 - team: *775 + team: *780 required: - action - team @@ -233319,9 +236189,9 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 repository: title: Repository description: A git repository @@ -233791,7 +236661,7 @@ webhooks: - topics - visibility sender: *4 - team: *775 + team: *780 required: - action - team @@ -233935,9 +236805,9 @@ webhooks: - from required: - permissions - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 repository: title: Repository description: A git repository @@ -234407,7 +237277,7 @@ webhooks: - topics - visibility sender: *4 - team: *775 + team: *780 required: - action - changes @@ -234485,9 +237355,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 repository: title: Repository description: A git repository @@ -234957,7 +237827,7 @@ webhooks: - topics - visibility sender: *4 - team: *775 + team: *780 required: - action - team @@ -235033,10 +237903,10 @@ webhooks: type: string enum: - started - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -235109,17 +237979,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *714 + enterprise: *719 inputs: type: - object - 'null' additionalProperties: true - installation: *715 - organization: *716 + installation: *720 + organization: *721 ref: type: string - repository: *717 + repository: *722 sender: *4 workflow: type: string @@ -235201,10 +238071,10 @@ webhooks: type: string enum: - completed - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 workflow_job: allOf: @@ -235460,7 +238330,7 @@ webhooks: type: string required: - conclusion - deployment: *486 + deployment: *490 required: - action - repository @@ -235539,10 +238409,10 @@ webhooks: type: string enum: - in_progress - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 workflow_job: allOf: @@ -235824,7 +238694,7 @@ webhooks: required: - status - steps - deployment: *486 + deployment: *490 required: - action - repository @@ -235903,10 +238773,10 @@ webhooks: type: string enum: - queued - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 workflow_job: type: object @@ -236052,7 +238922,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *486 + deployment: *490 required: - action - repository @@ -236131,10 +239001,10 @@ webhooks: type: string enum: - waiting - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 workflow_job: type: object @@ -236281,7 +239151,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *486 + deployment: *490 required: - action - repository @@ -236361,12 +239231,12 @@ webhooks: type: string enum: - completed - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - workflow: *729 + workflow: *734 workflow_run: title: Workflow Run type: object @@ -237385,12 +240255,12 @@ webhooks: type: string enum: - in_progress - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - workflow: *729 + workflow: *734 workflow_run: title: Workflow Run type: object @@ -238394,12 +241264,12 @@ webhooks: type: string enum: - requested - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - workflow: *729 + workflow: *734 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index f88197871c..7541edcc09 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -136,6 +136,10 @@ "name": "users", "description": "Interact with and view information about users and also current user." }, + { + "name": "code-quality", + "description": "Insights into reliability, maintainability, and efficiency of your codebase." + }, { "name": "codespaces", "description": "Endpoints to manage Codespaces using the REST API." @@ -144,6 +148,10 @@ "name": "copilot", "description": "Endpoints to manage Copilot using the REST API." }, + { + "name": "copilot-spaces", + "description": "Endpoints to manage Copilot Spaces using the REST API." + }, { "name": "security-advisories", "description": "Manage security advisories." @@ -5836,7 +5844,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -6976,7 +6984,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7903,7 +7911,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -8381,7 +8389,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -10839,7 +10847,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -12011,7 +12019,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -13047,7 +13055,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -13786,7 +13794,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -24979,7 +24987,7 @@ "/enterprises/{enterprise}/copilot/policies/coding_agent": { "put": { "summary": "Set the coding agent policy for an enterprise", - "description": "Sets the policy for Copilot coding agent usage across an enterprise.\n\nEnterprise owners can configure whether Copilot coding agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.\n\nOnly enterprise owners can set the coding agent policy for their enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "description": "Sets the policy for Copilot cloud agent usage across an enterprise.\n\nEnterprise owners can configure whether Copilot cloud agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.\n\nOnly enterprise owners can set the coding agent policy for their enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -25009,7 +25017,7 @@ "properties": { "policy_state": { "type": "string", - "description": "The policy state for Copilot coding agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.", + "description": "The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.", "enum": [ "enabled_for_all_orgs", "disabled_for_all_orgs", @@ -25116,7 +25124,7 @@ "/enterprises/{enterprise}/copilot/policies/coding_agent/organizations": { "post": { "summary": "Add organizations to the enterprise coding agent policy", - "description": "Enables Copilot coding agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can add organizations to the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "description": "Enables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can add organizations to the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -25137,7 +25145,7 @@ } ], "requestBody": { - "description": "The organizations to enable Copilot coding agent for", + "description": "The organizations to enable Copilot cloud agent for", "required": true, "content": { "application/json": { @@ -25146,7 +25154,7 @@ "properties": { "organizations": { "type": "array", - "description": "List of organization logins within the enterprise to enable Copilot coding agent for.", + "description": "List of organization logins within the enterprise to enable Copilot cloud agent for.", "items": { "type": "string" } @@ -25281,7 +25289,7 @@ }, "delete": { "summary": "Remove organizations from the enterprise coding agent policy", - "description": "Disables Copilot coding agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can remove organizations from the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "description": "Disables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can remove organizations from the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -25302,7 +25310,7 @@ } ], "requestBody": { - "description": "The organizations to disable Copilot coding agent for", + "description": "The organizations to disable Copilot cloud agent for", "required": true, "content": { "application/json": { @@ -25311,7 +25319,7 @@ "properties": { "organizations": { "type": "array", - "description": "List of organization logins within the enterprise to disable Copilot coding agent for.", + "description": "List of organization logins within the enterprise to disable Copilot cloud agent for.", "items": { "type": "string" } @@ -93134,6 +93142,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } }, "required": [ @@ -93197,6 +93209,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } } }, @@ -126716,17 +126732,17 @@ } } }, - "/orgs/{org}/copilot/billing": { + "/orgs/{org}/copilot-spaces": { "get": { - "summary": "Get Copilot seat information and settings for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "summary": "List organization Copilot Spaces", + "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/get-copilot-organization-details", + "operationId": "copilot-spaces/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-organization-copilot-spaces" }, "parameters": [ { @@ -126737,288 +126753,32 @@ "schema": { "type": "string" } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "title": "Copilot Organization Details", - "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.", - "type": "object", - "properties": { - "seat_breakdown": { - "title": "Copilot Seat Breakdown", - "description": "The breakdown of Copilot Business seats for the organization.", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "The total number of seats being billed for the organization as of the current billing cycle." - }, - "added_this_cycle": { - "type": "integer", - "description": "Seats added during the current billing cycle." - }, - "pending_cancellation": { - "type": "integer", - "description": "The number of seats that are pending cancellation at the end of the current billing cycle." - }, - "pending_invitation": { - "type": "integer", - "description": "The number of users who have been invited to receive a Copilot seat through this organization." - }, - "active_this_cycle": { - "type": "integer", - "description": "The number of seats that have used Copilot during the current billing cycle." - }, - "inactive_this_cycle": { - "type": "integer", - "description": "The number of seats that have not used Copilot during the current billing cycle." - } - } - }, - "public_code_suggestions": { - "type": "string", - "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).", - "enum": [ - "allow", - "block", - "unconfigured" - ] - }, - "ide_chat": { - "type": "string", - "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] - }, - "platform_chat": { - "type": "string", - "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] - }, - "cli": { - "type": "string", - "description": "The organization policy for allowing or disallowing Copilot CLI.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] - }, - "seat_management_setting": { - "type": "string", - "description": "The mode of assigning new seats.", - "enum": [ - "assign_all", - "assign_selected", - "disabled", - "unconfigured" - ] - }, - "plan_type": { - "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", - "enum": [ - "business", - "enterprise" - ] - } - }, - "required": [ - "seat_breakdown", - "public_code_suggestions", - "seat_management_setting" - ], - "additionalProperties": true - }, - "examples": { - "default": { - "value": { - "seat_breakdown": { - "total": 12, - "added_this_cycle": 9, - "pending_invitation": 0, - "pending_cancellation": 0, - "active_this_cycle": 12, - "inactive_this_cycle": 11 - }, - "seat_management_setting": "assign_selected", - "ide_chat": "enabled", - "platform_chat": "enabled", - "cli": "enabled", - "public_code_suggestions": "block", - "plan_type": "business" - } - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "There is a problem with your account's associated payment method." - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" - } - } - }, - "/orgs/{org}/copilot/billing/seats": { - "get": { - "summary": "List all Copilot seat assignments for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/list-copilot-seats", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" - }, - "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 } }, { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", "in": "query", "schema": { - "type": "integer", - "default": 1 + "type": "string" } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", "in": "query", "schema": { - "type": "integer", - "default": 50 + "type": "string" } } ], @@ -127029,23 +126789,76 @@ "application/json": { "schema": { "type": "object", + "required": [ + "spaces" + ], "properties": { - "total_seats": { - "type": "integer", - "description": "Total number of Copilot seats for the organization currently being billed." - }, - "seats": { + "spaces": { "type": "array", + "description": "The list of Copilot Spaces on this page of results.", "items": { - "title": "Copilot Business Seat Detail", - "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", "type": "object", "properties": { - "assignee": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { "anyOf": [ - { - "type": "null" - }, { "title": "Simple User", "description": "A GitHub user.", @@ -127213,13 +127026,6 @@ "type", "url" ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" }, { "title": "Organization Simple", @@ -127320,412 +127126,312 @@ "description" ] } - ] + ], + "description": "The user or organization that owns this space." }, - "assigning_team": { - "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", - "oneOf": [ - { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - { - "title": "Enterprise Team", - "description": "Group of enterprise owners and/or members", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "sync_to_organizations": { - "type": "string", - "description": "Retired: this field will not be returned with GHEC enterprise teams.", - "examples": [ - "disabled | all" - ] - }, - "organization_selection_type": { - "type": "string", - "examples": [ - "disabled | selected | all" - ] - }, - "group_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "62ab9291-fae2-468e-974b-7e45096d5021" - ] - }, - "group_name": { - "type": [ - "string", - "null" - ], - "description": "Retired: this field will not be returned with GHEC enterprise teams.", - "examples": [ - "Justice League" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/dc/teams/justice-league" - ] - }, - "members_url": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "url", - "members_url", - "name", - "html_url", - "slug", - "created_at", - "updated_at", - "group_id" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } - ], - "type": [ - "null", - "object" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "pending_cancellation_date": { - "type": [ - "string", - "null" - ], - "format": "date", - "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." - }, - "last_activity_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." - }, - "last_activity_editor": { - "type": [ - "string", - "null" - ], - "description": "Last editor that was used by the user for a GitHub Copilot completion." - }, - "last_authenticated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format." - }, "created_at": { "type": "string", "format": "date-time", - "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] }, "updated_at": { "type": "string", "format": "date-time", - "deprecated": true, - "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] }, - "plan_type": { + "html_url": { "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", - "enum": [ - "business", - "enterprise", - "unknown" + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } } }, "required": [ - "created_at" + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" ], "additionalProperties": false } @@ -127734,21 +127440,98 @@ }, "examples": { "default": { + "summary": "Example response for listing organization copilot spaces", "value": { - "total_seats": 2, - "seats": [ + "spaces": [ { - "created_at": "2021-08-03T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": null, - "last_activity_at": "2021-10-14T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "last_authenticated_at": "2021-10-14T00:53:32-06:00", - "plan_type": "business", - "assignee": { - "login": "octocat", + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "owner": { + "login": "octo-org", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3" + }, + { + "id": 85, + "number": 4, + "name": "Development Resources", + "description": "Shared development documentation and resources", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", @@ -127765,49 +127548,10 @@ "type": "User", "site_admin": false }, - "assigning_team": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - }, - { - "created_at": "2021-09-23T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": "2021-11-01", - "last_activity_at": "2021-10-13T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "last_authenticated_at": "2021-10-14T00:53:32-06:00", - "assignee": { - "login": "octokitten", - "id": 1, - "node_id": "MDQ76VNlcjE=", - "avatar_url": "https://github.com/images/error/octokitten_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octokitten", - "html_url": "https://github.com/octokitten", - "followers_url": "https://api.github.com/users/octokitten/followers", - "following_url": "https://api.github.com/users/octokitten/following{/other_user}", - "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", - "organizations_url": "https://api.github.com/users/octokitten/orgs", - "repos_url": "https://api.github.com/users/octokitten/repos", - "events_url": "https://api.github.com/users/octokitten/events{/privacy}", - "received_events_url": "https://api.github.com/users/octokitten/received_events", - "type": "User", - "site_admin": false - } + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/4", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/4" } ] } @@ -127824,58 +127568,6 @@ } } }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "403": { "description": "Forbidden", "content": { @@ -127930,24 +127622,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } - } - }, - "/orgs/{org}/copilot/billing/selected_teams": { + }, "post": { - "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "summary": "Create an organization Copilot Space", + "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/add-copilot-seats-for-teams", + "operationId": "copilot-spaces/create-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-an-organization-copilot-space" }, "parameters": [ { @@ -127961,292 +127650,855 @@ } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "selected_teams": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "Team Planning Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Organization space for team planning and coordination" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help the team with planning and coordination tasks" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions for organization members.\n- `no_access`: No default access (default)\n- `reader`: Organization members can read the space\n- `writer`: Organization members can read and edit the space\n- `admin`: Organization members have full admin access to the space", + "default": "no_access" + }, + "resources_attributes": { "type": "array", - "description": "List of team names within the organization to which to grant access to GitHub Copilot.", + "description": "Resources to attach to the space.", "items": { - "type": "string" - }, - "minItems": 1 + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } } }, "required": [ - "selected_teams" + "name" ] }, "examples": { "default": { "value": { - "selected_teams": [ - "engteam1", - "engteam2", - "engteam3" + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/planning.md" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology and holds daily standups" + } + } ] } } } } - }, - "required": true + } }, "responses": { "201": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats created for members of the specified team(s).", - "properties": { - "seats_created": { - "type": "integer" - } - }, - "required": [ - "seats_created" - ] - }, - "examples": { - "default": { - "value": { - "seats_created": 5 - } - } - } - } - } - }, - "500": { - "description": "Internal Error", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] }, - "url": { - "type": "string" + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] }, - "documentation_url": { - "type": "string" + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] }, - "url": { - "type": "string" + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] }, - "documentation_url": { - "type": "string" + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." }, - "url": { - "type": "string" + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] }, - "documentation_url": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] }, - "url": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" - } - }, - "delete": { - "summary": "Remove teams from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/cancel-copilot-seat-assignment-for-teams", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_teams": { - "type": "array", - "description": "The names of teams from which to revoke access to GitHub Copilot.", - "items": { - "type": "string" + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] }, - "minItems": 1 - } - }, - "required": [ - "selected_teams" - ] - }, - "examples": { - "default": { - "value": { - "selected_teams": [ - "engteam1", - "engteam2", - "engteam3" - ] - } - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", - "properties": { - "seats_cancelled": { - "type": "integer" + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } } }, "required": [ - "seats_cancelled" - ] + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false }, "examples": { "default": { + "summary": "Example response for an organization copilot space", "value": { - "seats_cancelled": 5 - } - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] } } } } } }, - "401": { - "description": "Requires authentication", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -128271,8 +128523,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -128297,14 +128549,18 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -128312,40 +128568,81 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } } }, - "/orgs/{org}/copilot/billing/selected_users": { - "post": { - "summary": "Add users to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "/orgs/{org}/copilot-spaces/{space_number}": { + "get": { + "summary": "Get an organization Copilot Space", + "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/add-copilot-seats-for-users", + "operationId": "copilot-spaces/get-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-an-organization-copilot-space" }, "parameters": [ { @@ -128356,313 +128653,738 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_usernames": { - "type": "array", - "description": "The usernames of the organization members to be granted access to GitHub Copilot.", - "items": { - "type": "string" - }, - "minItems": 1 - } - }, - "required": [ - "selected_usernames" - ] - }, - "examples": { - "default": { - "value": { - "selected_usernames": [ - "cooluser1", - "hacker2", - "octocat" - ] - } - } - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats created for the specified user(s).", - "properties": { - "seats_created": { - "type": "integer" - } - }, - "required": [ - "seats_created" - ] - }, - "examples": { - "default": { - "value": { - "seats_created": 5 - } - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" - } - }, - "delete": { - "summary": "Remove users from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/cancel-copilot-seat-assignment-for-users", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization" - }, - "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_usernames": { - "type": "array", - "description": "The usernames of the organization members for which to revoke access to GitHub Copilot.", - "items": { - "type": "string" - }, - "minItems": 1 - } - }, - "required": [ - "selected_usernames" - ] - }, - "examples": { - "default": { - "value": { - "selected_usernames": [ - "cooluser1", - "hacker2", - "octocat" - ] - } - } - } - } - }, - "required": true - }, "responses": { "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats set to \"pending cancellation\" for the specified users.", - "properties": { - "seats_cancelled": { - "type": "integer" - } - }, - "required": [ - "seats_cancelled" - ] - }, - "examples": { - "default": { - "value": { - "seats_cancelled": 5 - } - } - } - } - } - }, - "500": { - "description": "Internal Error", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] }, - "documentation_url": { - "type": "string" + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] }, - "url": { - "type": "string" + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] }, - "documentation_url": { - "type": "string" + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] }, - "url": { - "type": "string" + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] }, - "status": { - "type": "string" + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + }, + "examples": { + "default": { + "summary": "Example response for an organization copilot space", + "value": { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] } } } @@ -128720,30 +129442,24 @@ } } } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team." } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } - } - }, - "/orgs/{org}/copilot/coding-agent/permissions": { - "get": { - "summary": "Get Copilot coding agent permissions for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about which repositories in an organization have been enabled\nor disabled for the Copilot coding agent.\n\nOrganization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + }, + "put": { + "summary": "Set an organization Copilot Space", + "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/get-copilot-coding-agent-permissions-organization", + "operationId": "copilot-spaces/update-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-an-organization-copilot-space" }, "parameters": [ { @@ -128754,86 +129470,868 @@ "schema": { "type": "string" } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "Updated Team Planning Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Updated organization space for team planning and coordination" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Updated instructions to help the team with planning and coordination tasks" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions for organization members. Changing this field requires admin permissions.\n- `no_access`: No default access (default)\n- `reader`: Organization members can read the space\n- `writer`: Organization members can read and edit the space\n- `admin`: Organization members have full admin access to the space" + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "Updated Team Planning Space", + "description": "Updated organization space for team planning and coordination", + "general_instructions": "Updated instructions to help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/updated-planning.md" + } + }, + { + "id": 789, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Team Guidelines", + "text": "Our updated team follows agile methodology and holds daily standups" + } + } + ] + } + } + } + } + } + }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", "type": "object", "properties": { - "enabled_repositories": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", "enum": [ - "all", - "selected", - "none" + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" ] }, - "selected_repositories_url": { + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { "type": "string", - "description": "The URL for the selected repositories endpoint. Only present when `enabled_repositories` is `selected`." + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } } }, "required": [ - "enabled_repositories" - ] + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false }, "examples": { - "all_enabled": { - "summary": "All repositories enabled", - "value": { - "enabled_repositories": "all" - } - }, - "selected_enabled": { - "summary": "Selected repositories enabled", - "value": { - "enabled_repositories": "selected", - "selected_repositories_url": "https://api.github.com/orgs/my-org/copilot/coding-agent/permissions/repositories" - } - }, - "none_enabled": { - "summary": "No repositories enabled", + "default": { + "summary": "Example response for an organization copilot space", "value": { - "enabled_repositories": "none" - } - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] } } } } } }, - "401": { - "description": "Requires authentication", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -128858,8 +130356,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -128884,14 +130382,18 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -128899,11 +130401,56 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -128912,22 +130459,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } }, - "put": { - "summary": "Set Copilot coding agent permissions for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets the policy for which repositories in an organization can use Copilot coding agent.\n\nOrganization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "delete": { + "summary": "Delete an organization Copilot Space", + "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/set-copilot-coding-agent-permissions-organization", + "operationId": "copilot-spaces/delete-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-an-organization-copilot-space" }, "parameters": [ { @@ -128938,120 +130484,20 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "enabled_repositories": { - "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", - "enum": [ - "all", - "selected", - "none" - ] - } - }, - "required": [ - "enabled_repositories" - ] - }, - "examples": { - "default": { - "value": { - "enabled_repositories": "selected" - } - } - } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } - }, + ], "responses": { "204": { - "description": "No Content" - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } + "description": "The Copilot Space has been successfully deleted." }, "404": { "description": "Resource not found", @@ -129156,24 +130602,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } } }, - "/orgs/{org}/copilot/coding-agent/permissions/repositories": { + "/orgs/{org}/copilot-spaces/{space_number}/collaborators": { "get": { - "summary": "List repositories enabled for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists the selected repositories that are enabled for Copilot coding agent in an organization.\n\nOrganization owners can use this endpoint when the coding agent repository policy\nis set to `selected` to see which repositories have been enabled.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "List collaborators for an organization Copilot Space", + "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/list-copilot-coding-agent-selected-repositories-for-organization", + "operationId": "copilot-spaces/list-collaborators-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-an-organization-copilot-space" }, "parameters": [ { @@ -129186,21 +130631,12 @@ } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], @@ -129211,1206 +130647,375 @@ "application/json": { "schema": { "type": "object", + "required": [ + "collaborators" + ], "properties": { - "total_count": { - "type": "integer" - }, - "repositories": { + "collaborators": { "type": "array", + "description": "The list of collaborators for this Copilot Space.", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." }, - "login": { + "role": { "type": "string", - "examples": [ - "octocat" - ] + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" }, "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "type": "integer" }, "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "type": "string" }, - "avatar_url": { + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "enum": [ + "Team" ] }, - "gravatar_id": { + "description": { "type": [ "string", "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" ] }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "privacy": { + "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "notification_setting": { + "type": "string" }, - "repos_url": { + "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "format": "uri" }, - "events_url": { + "html_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri" }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "members_url": { + "type": "string" }, - "type": { + "repositories_url": { "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" + "format": "uri" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "organization_id": { + "type": "integer" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" + "parent": { + "type": [ + "null" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", + "actor_type", + "role", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "name", + "slug", + "type" ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_bypass": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - }, - "mode": { - "type": "string", - "description": "The bypass mode for the reviewer", - "enum": [ - "ALWAYS", - "EXEMPT" - ], - "default": "ALWAYS" - } - } - } - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ], - "x-github-breaking-changes": [ - { - "changeset": "remove_has_downloads", - "patch": { - "properties": { - "has_downloads": null - } - }, - "version": "2026-03-10" } ] } } - }, - "required": [ - "total_count", - "repositories" - ] + } }, "examples": { "default": { "value": { - "total_count": 1, - "repositories": [ + "collaborators": [ { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "octo-org", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "organization": null, - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "template_repository": null, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "delete_branch_on_merge": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "description": "A great organization" + } } ] } @@ -130419,58 +131024,6 @@ } } }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "403": { "description": "Forbidden", "content": { @@ -130522,51 +131075,24 @@ } } } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "collaborators" } }, - "put": { - "summary": "Set selected repositories for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReplaces the list of selected repositories that are enabled for Copilot coding\nagent in an organization. This method can only be called when the coding agent\nrepository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "post": { + "summary": "Add a collaborator to an organization Copilot Space", + "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/set-copilot-coding-agent-selected-repositories-for-organization", + "operationId": "copilot-spaces/add-collaborator-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-an-organization-copilot-space" }, "parameters": [ { @@ -130577,6 +131103,15 @@ "schema": { "type": "string" } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -130585,27 +131120,48 @@ "application/json": { "schema": { "type": "object", + "required": [ + "actor_type", + "actor_identifier", + "role" + ], "properties": { - "selected_repository_ids": { - "description": "List of repository IDs to enable for Copilot coding agent.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - } + "actor_type": { + "type": "string", + "enum": [ + "User", + "Team" + ], + "description": "The type of actor (user or team)." + }, + "actor_identifier": { + "type": "string", + "description": "The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role to grant to the collaborator." } - }, - "required": [ - "selected_repository_ids" - ] + } }, "examples": { - "default": { + "user": { "value": { - "selected_repository_ids": [ - 32, - 42 - ] + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" + } + }, + "team": { + "value": { + "actor_type": "Team", + "actor_identifier": "developers", + "role": "reader" } } } @@ -130613,55 +131169,355 @@ } }, "responses": { - "204": { - "description": "No Content" - }, - "500": { - "description": "Internal Error", + "201": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] }, - "status": { - "type": "string" + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + ] + }, + "examples": { + "user": { + "value": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "team": { + "value": { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 } } } @@ -130720,32 +131576,6 @@ } } }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { @@ -130823,24 +131653,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "collaborators" } } }, - "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}": { + "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { "put": { - "summary": "Enable a repository for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nAdds a repository to the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Set a collaborator role for an organization Copilot Space", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/enable-copilot-coding-agent-for-repository-in-organization", + "operationId": "copilot-spaces/update-collaborator-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-an-organization-copilot-space" }, "parameters": [ { @@ -130853,71 +131682,428 @@ } }, { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { "type": "integer" } + }, + { + "name": "actor_type", + "description": "The type of actor (user or team).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], - "responses": { - "204": { - "description": "No Content" - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "role" + ], + "properties": { + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The new role to grant to the collaborator. Use `no_access` to remove the collaborator." + } + } + }, + "examples": { + "default": { + "value": { + "role": "admin" } } } } - }, - "401": { - "description": "Requires authentication", + } + }, + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] }, - "status": { - "type": "string" + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + }, + "examples": { + "user": { + "value": { + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "team": { + "value": { + "actor_type": "Team", + "role": "admin", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 } } } } } }, + "204": { + "description": "Response when `role` is `no_access` and the collaborator was removed." + }, "403": { "description": "Forbidden", "content": { @@ -130970,32 +132156,6 @@ } } }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { @@ -131073,22 +132233,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "collaborators" } }, "delete": { - "summary": "Disable a repository for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemoves a repository from the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint.", + "summary": "Remove a collaborator from an organization Copilot Space", + "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/disable-copilot-coding-agent-for-repository-in-organization", + "operationId": "copilot-spaces/remove-collaborator-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-an-organization-copilot-space" }, "parameters": [ { @@ -131101,21 +132260,43 @@ } }, { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { "type": "integer" } + }, + { + "name": "actor_type", + "description": "The type of actor (user or team).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], "responses": { "204": { - "description": "No Content" + "description": "Response" }, - "500": { - "description": "Internal Error", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -131140,8 +132321,8 @@ } } }, - "401": { - "description": "Requires authentication", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -131165,35 +132346,151 @@ } } } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + } + }, + "/orgs/{org}/copilot-spaces/{space_number}/resources": { + "get": { + "summary": "List resources for an organization Copilot Space", + "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-resources-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-an-organization-copilot-space" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "403": { - "description": "Forbidden", + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", + "required": [ + "resources" + ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "resources": [ + { + "id": 1, + "resource_type": "repository", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42 + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + { + "id": 2, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + ] } } } } } }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -131218,8 +132515,8 @@ } } }, - "409": { - "description": "Conflict", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -131246,187 +132543,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/orgs/{org}/copilot/content_exclusion": { - "get": { - "summary": "Get Copilot content exclusion rules for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot content exclusion path rules.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can view details about Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `copilot` or `read:org` scopes to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.\n> * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.", + }, + "post": { + "summary": "Create a resource for an organization Copilot Space", + "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/copilot-content-exclusion-for-organization", + "operationId": "copilot-spaces/create-resource-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "title": "Copilot Organization Content Exclusion Details", - "description": "List all Copilot Content Exclusion rules for an organization.", - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string", - "description": "The path to the file that will be excluded." - } - } - }, - "examples": { - "default": { - "value": { - "octo-repo": [ - "/src/some-dir/kernel.rs" - ] - } - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-content-exclusion-management" - } - }, - "put": { - "summary": "Set Copilot content exclusion rules for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets Copilot content exclusion path rules for an organization.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can set Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.\n> * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.", - "tags": [ - "copilot" - ], - "operationId": "copilot/set-copilot-content-exclusion-for-organization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-an-organization-copilot-space" }, "parameters": [ { @@ -131437,64 +132568,72 @@ "schema": { "type": "string" } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { - "description": "The content exclusion rules to set", "required": true, "content": { "application/json": { "schema": { "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string", - "description": "The path to the file that will be excluded." - }, - { - "type": "object", - "properties": { - "ifAnyMatch": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "ifAnyMatch" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ifNoneMatch": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "ifNoneMatch" - ], - "additionalProperties": false - } - ] + "required": [ + "resource_type", + "metadata" + ], + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ], + "description": "The type of resource to create." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata.", + "additionalProperties": true } } }, "examples": { - "default": { - "summary": "Example of content exclusion paths", + "free_text": { "value": { - "octo-repo": [ - "/src/some-dir/kernel.rs" - ] + "resource_type": "free_text", + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + } + } + }, + "repository": { + "value": { + "resource_type": "repository", + "metadata": { + "repository_id": 42 + } + } + }, + "github_file": { + "value": { + "resource_type": "github_file", + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + } } } } @@ -131502,74 +132641,151 @@ } }, "responses": { - "200": { - "description": "Success", + "201": { + "description": "Resource created", "content": { "application/json": { "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." } - } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] }, "examples": { "default": { "value": { - "message": "Content exclusion rules updated successfully." + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" } } } } } }, - "500": { - "description": "Internal Error", + "200": { + "description": "Duplicate github_file resource already exists", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "id": { + "type": "integer", + "description": "The unique identifier of the resource." }, - "url": { - "type": "string" + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." }, - "documentation_url": { - "type": "string" + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true }, - "url": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." }, - "status": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "github_file", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" } } } @@ -131628,39 +132844,13 @@ } } }, - "413": { - "description": "Payload Too Large", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Validation Error", + "description": "Validation Error", "type": "object", "required": [ "message", @@ -131676,7 +132866,52 @@ "errors": { "type": "array", "items": { - "type": "string" + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } } } } @@ -131686,24 +132921,23 @@ } }, "x-github": { - "githubCloudOnly": null, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-content-exclusion-management" + "category": "copilot-spaces", + "subcategory": "resources" } } }, - "/orgs/{org}/copilot/metrics": { + "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": { "get": { - "summary": "Get Copilot metrics for an organization", - "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "summary": "Get a resource for an organization Copilot Space", + "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/copilot-metrics-for-organization", + "operationId": "copilot-spaces/get-resource-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" + "url": "https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-an-organization-copilot-space" }, "parameters": [ { @@ -131716,39 +132950,21 @@ } }, { - "name": "since", - "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "until", - "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } }, { - "name": "per_page", - "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 100 + "type": "integer" } } ], @@ -131758,504 +132974,70 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Copilot Usage Metrics", - "description": "Copilot usage metrics for a given day.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "total_engaged_users": { - "type": "integer", - "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "copilot_ide_code_completions": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." - } - } - } - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot code completion metrics for active editors.", - "additionalProperties": true, - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages, for the given editor.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions, for the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_suggestions": { - "type": "integer", - "description": "The number of Copilot code suggestions generated for the given editor, for the given language." - }, - "total_code_acceptances": { - "type": "integer", - "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." - }, - "total_code_lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." - } - } - } - } - } - } - } - } - } - } - } - }, - "copilot_ide_chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in the IDE.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat in the IDE." - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot Chat metrics, for active editors.", - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the specified editor." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the given editor and model." - }, - "total_chats": { - "type": "integer", - "description": "The total number of chats initiated by users in the given editor and model." - }, - "total_chat_insertion_events": { - "type": "integer", - "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." - }, - "total_chat_copy_events": { - "type": "integer", - "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." - } - } - } - } - } - } - } - } - }, - "copilot_dotcom_chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in GitHub.com", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once." - }, - "models": { - "type": "array", - "description": "List of model metrics for a custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model (if applicable)." - }, - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." - }, - "total_chats": { - "type": "integer", - "description": "Total number of chats initiated by users on github.com." - } - } - } - } - } - }, - "copilot_dotcom_pull_requests": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot for pull requests.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." - }, - "repositories": { - "type": "array", - "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Repository name" - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_pr_summaries_created": { - "type": "integer", - "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." - } - } - } - } - } - } - } - } - } - }, - "required": [ - "date" - ], - "additionalProperties": true - } - }, - "examples": { - "default": { - "value": [ - { - "date": "2024-06-24", - "total_active_users": 24, - "total_engaged_users": 20, - "copilot_ide_code_completions": { - "total_engaged_users": 20, - "languages": [ - { - "name": "python", - "total_engaged_users": 10 - }, - { - "name": "ruby", - "total_engaged_users": 10 - } - ], - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 13, - "languages": [ - { - "name": "python", - "total_engaged_users": 6, - "total_code_suggestions": 249, - "total_code_acceptances": 123, - "total_code_lines_suggested": 225, - "total_code_lines_accepted": 135 - }, - { - "name": "ruby", - "total_engaged_users": 7, - "total_code_suggestions": 496, - "total_code_acceptances": 253, - "total_code_lines_suggested": 520, - "total_code_lines_accepted": 270 - } - ] - } - ] - }, - { - "name": "neovim", - "total_engaged_users": 7, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "languages": [ - { - "name": "typescript", - "total_engaged_users": 3, - "total_code_suggestions": 112, - "total_code_acceptances": 56, - "total_code_lines_suggested": 143, - "total_code_lines_accepted": 61 - }, - { - "name": "go", - "total_engaged_users": 4, - "total_code_suggestions": 132, - "total_code_acceptances": 67, - "total_code_lines_suggested": 154, - "total_code_lines_accepted": 72 - } - ] - } - ] - } - ] - }, - "copilot_ide_chat": { - "total_engaged_users": 13, - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 12, - "total_chats": 45, - "total_chat_insertion_events": 12, - "total_chat_copy_events": 16 - }, - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_engaged_users": 1, - "total_chats": 10, - "total_chat_insertion_events": 11, - "total_chat_copy_events": 3 - } - ] - } - ] - }, - "copilot_dotcom_chat": { - "total_engaged_users": 14, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 14, - "total_chats": 38 - } - ] - }, - "copilot_dotcom_pull_requests": { - "total_engaged_users": 12, - "repositories": [ - { - "name": "demo/repo1", - "total_engaged_users": 8, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_pr_summaries_created": 6, - "total_engaged_users": 8 - } - ] - }, - { - "name": "demo/repo2", - "total_engaged_users": 4, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_pr_summaries_created": 10, - "total_engaged_users": 4 - } - ] - } - ] - } - } - ] - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "type": "integer", + "description": "The unique identifier of the resource." }, - "documentation_url": { - "type": "string" + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] }, - "url": { - "type": "string" + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." }, - "status": { - "type": "string" + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" } } } @@ -132313,53 +133095,24 @@ } } } - }, - "422": { - "description": "Copilot Usage Metrics API setting is disabled at the organization or enterprise level.", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-metrics" + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/orgs/{org}/copilot/metrics/reports/organization-1-day": { - "get": { - "summary": "Get Copilot organization usage metrics for a specific day", - "description": "Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + }, + "put": { + "summary": "Set a resource for an organization Copilot Space", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/copilot-organization-one-day-usage-metrics", + "operationId": "copilot-spaces/update-resource-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day" + "url": "https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-an-organization-copilot-space" }, "parameters": [ { @@ -132372,67 +133125,129 @@ } }, { - "name": "day", - "description": "The day to request data for, in `YYYY-MM-DD` format.", - "in": "query", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", "required": true, "schema": { - "type": "string", - "format": "date", - "examples": [ - "2025-10-13" - ] + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "Updated resource-specific metadata.", + "additionalProperties": true + } + } + }, + "examples": { + "default": { + "value": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + } + } + } + } + } + }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", "type": "object", - "title": "Copilot Metrics 1 Day Report", - "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", "properties": { - "download_links": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + "id": { + "type": "integer", + "description": "The unique identifier of the resource." }, - "report_day": { + "resource_type": { "type": "string", - "format": "date", - "description": "The day of the report in `YYYY-MM-DD` format." + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." } }, "required": [ - "download_links", - "report_day" + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" ] }, "examples": { "default": { "value": { - "download_links": [ - "https://example.com/copilot-usage-report-1.json", - "https://example.com/copilot-usage-report-2.json" - ], - "report_day": "2025-07-01" + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" } } } } } }, - "204": { - "description": "A header with no content is returned." - }, - "500": { - "description": "Internal Error", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -132457,8 +133272,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -132483,14 +133298,18 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -132498,11 +133317,56 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -132511,24 +133375,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage-metrics" + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest": { - "get": { - "summary": "Get Copilot organization usage metrics", - "description": "Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + }, + "delete": { + "summary": "Delete a resource from an organization Copilot Space", + "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/copilot-organization-usage-metrics", + "operationId": "copilot-spaces/delete-resource-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics" + "url": "https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-an-organization-copilot-space" }, "parameters": [ { @@ -132539,83 +133400,29 @@ "schema": { "type": "string" } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Copilot Metrics 28 Day Report", - "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", - "properties": { - "download_links": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." - }, - "report_start_day": { - "type": "string", - "format": "date", - "description": "The start date of the report period in `YYYY-MM-DD` format." - }, - "report_end_day": { - "type": "string", - "format": "date", - "description": "The end date of the report period in `YYYY-MM-DD` format." - } - }, - "required": [ - "download_links", - "report_start_day", - "report_end_day" - ] - }, - "examples": { - "default": { - "value": { - "download_links": [ - "https://example.com/copilot-usage-report-1.json", - "https://example.com/copilot-usage-report-2.json" - ], - "report_start_day": "2025-07-01", - "report_end_day": "2025-07-28" - } - } - } - } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } + } + ], + "responses": { + "204": { + "description": "Response" }, "403": { "description": "Forbidden", @@ -132671,24 +133478,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage-metrics" + "category": "copilot-spaces", + "subcategory": "resources" } } }, - "/orgs/{org}/copilot/metrics/reports/users-1-day": { + "/orgs/{org}/copilot/billing": { "get": { - "summary": "Get Copilot organization users usage metrics for a specific day", - "description": "Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "summary": "Get Copilot seat information and settings for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], - "operationId": "copilot/copilot-organization-users-one-day-usage-metrics", + "operationId": "copilot/get-copilot-organization-details", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization" }, "parameters": [ { @@ -132699,67 +133505,134 @@ "schema": { "type": "string" } - }, - { - "name": "day", - "description": "The day to request data for, in `YYYY-MM-DD` format.", - "in": "query", - "required": true, - "schema": { - "type": "string", - "format": "date", - "examples": [ - "2025-10-13" - ] - } } ], "responses": { "200": { - "description": "Response", + "description": "OK", "content": { "application/json": { "schema": { + "title": "Copilot Organization Details", + "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.", "type": "object", - "title": "Copilot Metrics 1 Day Report", - "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", "properties": { - "download_links": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + "seat_breakdown": { + "title": "Copilot Seat Breakdown", + "description": "The breakdown of Copilot Business seats for the organization.", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "The total number of seats being billed for the organization as of the current billing cycle." + }, + "added_this_cycle": { + "type": "integer", + "description": "Seats added during the current billing cycle." + }, + "pending_cancellation": { + "type": "integer", + "description": "The number of seats that are pending cancellation at the end of the current billing cycle." + }, + "pending_invitation": { + "type": "integer", + "description": "The number of users who have been invited to receive a Copilot seat through this organization." + }, + "active_this_cycle": { + "type": "integer", + "description": "The number of seats that have used Copilot during the current billing cycle." + }, + "inactive_this_cycle": { + "type": "integer", + "description": "The number of seats that have not used Copilot during the current billing cycle." + } + } }, - "report_day": { + "public_code_suggestions": { "type": "string", - "format": "date", - "description": "The day of the report in `YYYY-MM-DD` format." + "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).", + "enum": [ + "allow", + "block", + "unconfigured" + ] + }, + "ide_chat": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "platform_chat": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "cli": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot CLI.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "seat_management_setting": { + "type": "string", + "description": "The mode of assigning new seats.", + "enum": [ + "assign_all", + "assign_selected", + "disabled", + "unconfigured" + ] + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise" + ] } }, "required": [ - "download_links", - "report_day" - ] + "seat_breakdown", + "public_code_suggestions", + "seat_management_setting" + ], + "additionalProperties": true }, "examples": { "default": { "value": { - "download_links": [ - "https://example.com/copilot-usage-report-1.json", - "https://example.com/copilot-usage-report-2.json" - ], - "report_day": "2025-07-01" + "seat_breakdown": { + "total": 12, + "added_this_cycle": 9, + "pending_invitation": 0, + "pending_cancellation": 0, + "active_this_cycle": 12, + "inactive_this_cycle": 11 + }, + "seat_management_setting": "assign_selected", + "ide_chat": "enabled", + "platform_chat": "enabled", + "cli": "enabled", + "public_code_suggestions": "block", + "plan_type": "business" } } } } } }, - "204": { - "description": "A header with no content is returned." - }, "500": { "description": "Internal Error", "content": { @@ -132786,142 +133659,8 @@ } } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage-metrics" - } - } - }, - "/orgs/{org}/copilot/metrics/reports/users-28-day/latest": { - "get": { - "summary": "Get Copilot organization users usage metrics", - "description": "Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", - "tags": [ - "copilot" - ], - "operationId": "copilot/copilot-organization-users-usage-metrics", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Copilot Metrics 28 Day Report", - "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", - "properties": { - "download_links": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." - }, - "report_start_day": { - "type": "string", - "format": "date", - "description": "The start date of the report period in `YYYY-MM-DD` format." - }, - "report_end_day": { - "type": "string", - "format": "date", - "description": "The end date of the report period in `YYYY-MM-DD` format." - } - }, - "required": [ - "download_links", - "report_start_day", - "report_end_day" - ] - }, - "examples": { - "default": { - "value": { - "download_links": [ - "https://example.com/copilot-usage-report-1.json", - "https://example.com/copilot-usage-report-2.json" - ], - "report_start_day": "2025-07-01", - "report_end_day": "2025-07-28" - } - } - } - } - } - }, - "500": { - "description": "Internal Error", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -132997,27 +133736,30 @@ } } } + }, + "422": { + "description": "There is a problem with your account's associated payment method." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "copilot", - "subcategory": "copilot-usage-metrics" + "subcategory": "copilot-user-management" } } }, - "/orgs/{org}/dependabot/alerts": { + "/orgs/{org}/copilot/billing/seats": { "get": { - "summary": "List Dependabot alerts for an organization", - "description": "Lists Dependabot alerts for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "summary": "List all Copilot seat assignments for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/list-alerts-for-org", + "operationId": "copilot/list-copilot-seats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" }, "parameters": [ { @@ -133030,163 +133772,12 @@ } }, { - "name": "classification", - "in": "query", - "description": "A comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned.\n\nCan be: `malware`, `general`", - "schema": { - "type": "string" - } - }, - { - "name": "state", - "in": "query", - "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`", - "schema": { - "type": "string" - } - }, - { - "name": "severity", - "in": "query", - "description": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`", - "schema": { - "type": "string" - } - }, - { - "name": "ecosystem", - "in": "query", - "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`", - "schema": { - "type": "string" - } - }, - { - "name": "package", - "in": "query", - "description": "A comma-separated list of package names. If specified, only alerts for these packages will be returned.", - "schema": { - "type": "string" - } - }, - { - "name": "epss_percentage", - "in": "query", - "description": "CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.", - "schema": { - "type": "string" - } - }, - { - "name": "artifact_registry_url", - "in": "query", - "description": "A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.", - "schema": { - "type": "string" - } - }, - { - "name": "artifact_registry", - "in": "query", - "description": "A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned.\n\nCan be: `jfrog-artifactory`", - "schema": { - "type": "string" - } - }, - { - "name": "has", - "in": "query", - "description": "Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple `has` filters can be passed to filter for alerts that have all of the values.", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "patch", - "deployment" - ] - } - } - ] - } - }, - { - "name": "assignee", - "in": "query", - "description": "Filter alerts by assignees.\nProvide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users.\nUse `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.", - "schema": { - "type": "string" - } - }, - { - "name": "runtime_risk", - "in": "query", - "description": "A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned.\n\nCan be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement`", - "schema": { - "type": "string" - } - }, - { - "name": "scope", - "in": "query", - "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.", - "schema": { - "type": "string", - "enum": [ - "development", - "runtime" - ] - } - }, - { - "name": "sort", - "in": "query", - "description": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.", - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "epss_percentage" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", - "required": false, "schema": { - "type": "string" + "type": "integer", + "default": 1 } }, { @@ -133195,7 +133786,7 @@ "in": "query", "schema": { "type": "integer", - "default": 30 + "default": 50 } } ], @@ -133205,2292 +133796,38 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "description": "A Dependabot alert.", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the Dependabot alert.", - "readOnly": true, - "enum": [ - "auto_dismissed", - "dismissed", - "fixed", - "open" - ] - }, - "dependency": { - "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "manifest_path": { - "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true - }, - "scope": { - "type": [ - "string", - "null" - ], - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "enum": [ - "development", - "runtime", - null - ] - }, - "relationship": { - "type": [ - "string", - "null" - ], - "description": "The vulnerable dependency's relationship to your project.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.\n", - "readOnly": true, - "enum": [ - "unknown", - "direct", - "transitive", - "inconclusive", - null - ] - } - } - }, - "security_advisory": { + "type": "object", + "properties": { + "total_seats": { + "type": "integer", + "description": "Total number of Copilot seats for the organization currently being billed." + }, + "seats": { + "type": "array", + "items": { + "title": "Copilot Business Seat Detail", + "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, "properties": { - "ghsa_id": { - "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true - }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true - }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - } - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "classification": { - "type": "string", - "description": "The classification of the advisory.", - "readOnly": true, - "enum": [ - "general", - "malware" - ] - }, - "cvss": { - "type": "object", - "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", - "readOnly": true, - "properties": { - "score": { - "type": "number", - "description": "The overall CVSS score of the advisory.", - "minimum": 0, - "maximum": 10, - "readOnly": true + "assignee": { + "anyOf": [ + { + "type": "null" }, - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The full CVSS vector string for the advisory.", - "readOnly": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false - }, - "cvss_severities": { - "type": [ - "object", - "null" - ], - "properties": { - "cvss_v3": { - "type": [ - "object", - "null" - ], + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "vector_string": { + "name": { "type": [ "string", "null" - ], - "description": "The CVSS 3 vector string." + ] }, - "score": { + "email": { "type": [ - "number", - "null" - ], - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 4 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - } - } - }, - "epss": { - "type": [ - "object", - "null" - ], - "readOnly": true, - "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", - "properties": { - "percentage": { - "type": "number", - "minimum": 0, - "maximum": 100 - }, - "percentile": { - "type": "number", - "minimum": 0, - "maximum": 100 - } - } - }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } - }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { - "type": "object", - "description": "An advisory identifier.", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true - } - }, - "required": [ - "value", - "type" - ], - "additionalProperties": false - } - }, - "references": { - "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, - "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } - }, - "required": [ - "url" - ], - "additionalProperties": false - } - }, - "published_at": { - "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - } - }, - "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", - "severity", - "cvss", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false, - "x-github-breaking-changes": [ - { - "changeset": "deprecate_cvss", - "patch": { - "properties": { - "cvss": null - }, - "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", - "severity", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ] - }, - "version": "2026-03-10" - } - ] - }, - "security_vulnerability": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "created_at": { - "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "The reason that the alert was dismissed.", - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment associated with the alert's dismissal.", - "maxLength": 280 - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "auto_dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissal_request": { - "title": "Dependabot alert dismissal request", - "description": "Information about an active dismissal request for this Dependabot alert.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the dismissal request." - }, - "status": { - "type": "string", - "description": "The current status of the dismissal request.", - "enum": [ - "pending", - "approved", - "rejected", - "cancelled" - ] - }, - "requester": { - "type": "object", - "description": "The user who requested the dismissal.", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the user." - }, - "login": { - "type": "string", - "description": "The login name of the user." - } - } - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time when the dismissal request was created." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The API URL to get more information about this dismissal request." - } - } - }, - "assignees": { - "type": "array", - "description": "The users assigned to this alert.", - "readOnly": true, - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" - ] - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - } - }, - "required": [ - "number", - "state", - "dependency", - "security_advisory", - "security_vulnerability", - "url", - "html_url", - "created_at", - "updated_at", - "dismissed_at", - "dismissed_by", - "dismissed_reason", - "dismissed_comment", - "fixed_at", - "repository" - ], - "additionalProperties": false - } - }, - "examples": { - "default": { - "value": [ - { - "number": 2, - "state": "dismissed", - "dependency": { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "manifest_path": "path/to/requirements.txt", - "scope": "runtime" - }, - "security_advisory": { - "ghsa_id": "GHSA-rf4j-j272-fj86", - "cve_id": "CVE-2018-6188", - "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", - "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 2.0.0, < 2.0.2", - "first_patched_version": { - "identifier": "2.0.2" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 1.11.8, < 1.11.10", - "first_patched_version": { - "identifier": "1.11.10" - } - } - ], - "severity": "high", - "cvss": { - "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", - "score": 7.5 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", - "score": 7.5 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", - "score": 8.7 - } - }, - "epss": { - "percentage": 0.00045, - "percentile": "0.16001e0" - }, - "cwes": [ - { - "cwe_id": "CWE-200", - "name": "Exposure of Sensitive Information to an Unauthorized Actor" - } - ], - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-rf4j-j272-fj86" - }, - { - "type": "CVE", - "value": "CVE-2018-6188" - } - ], - "references": [ - { - "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" - }, - { - "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" - }, - { - "url": "https://usn.ubuntu.com/3559-1/" - }, - { - "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" - }, - { - "url": "http://www.securitytracker.com/id/1040422" - } - ], - "published_at": "2018-10-03T21:13:54Z", - "updated_at": "2022-04-26T18:35:37Z", - "withdrawn_at": null - }, - "security_vulnerability": { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 2.0.0, < 2.0.2", - "first_patched_version": { - "identifier": "2.0.2" - } - }, - "url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2", - "html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2", - "created_at": "2022-06-15T07:43:03Z", - "updated_at": "2022-08-23T14:29:47Z", - "dismissed_at": "2022-08-23T14:29:47Z", - "dismissed_by": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "dismissed_reason": "tolerable_risk", - "dismissed_comment": "This alert is accurate but we use a sanitizer.", - "fixed_at": null, - "assignees": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ], - "repository": { - "id": 217723378, - "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", - "name": "octo-repo", - "full_name": "octo-org/octo-repo", - "owner": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "private": true, - "html_url": "https://github.com/octo-org/octo-repo", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octo-org/octo-repo", - "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", - "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", - "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", - "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", - "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", - "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", - "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}" - } - }, - { - "number": 1, - "state": "open", - "dependency": { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "manifest_path": "path/to/requirements.txt", - "scope": "runtime" - }, - "security_advisory": { - "ghsa_id": "GHSA-8f4m-hccc-8qph", - "cve_id": "CVE-2021-20191", - "summary": "Insertion of Sensitive Information into Log File in ansible", - "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": ">= 2.9.0, < 2.9.18", - "first_patched_version": { - "identifier": "2.9.18" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { - "identifier": "2.8.19" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": ">= 2.10.0, < 2.10.7", - "first_patched_version": { - "identifier": "2.10.7" - } - } - ], - "severity": "medium", - "cvss": { - "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", - "score": 5.5 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", - "score": 5.5 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", - "score": 8.5 - } - }, - "cwes": [ - { - "cwe_id": "CWE-532", - "name": "Insertion of Sensitive Information into Log File" - } - ], - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-8f4m-hccc-8qph" - }, - { - "type": "CVE", - "value": "CVE-2021-20191" - } - ], - "references": [ - { - "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" - }, - { - "url": "https://access.redhat.com/security/cve/cve-2021-20191" - }, - { - "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" - } - ], - "published_at": "2021-06-01T17:38:00Z", - "updated_at": "2021-08-12T23:06:00Z", - "withdrawn_at": null - }, - "security_vulnerability": { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { - "identifier": "2.8.19" - } - }, - "url": "https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1", - "html_url": "https://github.com/octo-org/hello-world/security/dependabot/1", - "created_at": "2022-06-14T15:21:52Z", - "updated_at": "2022-06-14T15:21:52Z", - "dismissed_at": null, - "dismissed_by": null, - "dismissed_reason": null, - "dismissed_comment": null, - "fixed_at": null, - "assignees": [], - "repository": { - "id": 664700648, - "node_id": "MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=", - "name": "hello-world", - "full_name": "octo-org/hello-world", - "owner": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "private": true, - "html_url": "https://github.com/octo-org/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octo-org/hello-world", - "archive_url": "https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octo-org/hello-world/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octo-org/hello-world/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octo-org/hello-world/comments{/number}", - "commits_url": "https://api.github.com/repos/octo-org/hello-world/commits{/sha}", - "compare_url": "https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octo-org/hello-world/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octo-org/hello-world/contributors", - "deployments_url": "https://api.github.com/repos/octo-org/hello-world/deployments", - "downloads_url": "https://api.github.com/repos/octo-org/hello-world/downloads", - "events_url": "https://api.github.com/repos/octo-org/hello-world/events", - "forks_url": "https://api.github.com/repos/octo-org/hello-world/forks", - "git_commits_url": "https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}", - "hooks_url": "https://api.github.com/repos/octo-org/hello-world/hooks", - "issue_comment_url": "https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octo-org/hello-world/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octo-org/hello-world/issues{/number}", - "keys_url": "https://api.github.com/repos/octo-org/hello-world/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octo-org/hello-world/labels{/name}", - "languages_url": "https://api.github.com/repos/octo-org/hello-world/languages", - "merges_url": "https://api.github.com/repos/octo-org/hello-world/merges", - "milestones_url": "https://api.github.com/repos/octo-org/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octo-org/hello-world/pulls{/number}", - "releases_url": "https://api.github.com/repos/octo-org/hello-world/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octo-org/hello-world/stargazers", - "statuses_url": "https://api.github.com/repos/octo-org/hello-world/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octo-org/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/hello-world/subscription", - "tags_url": "https://api.github.com/repos/octo-org/hello-world/tags", - "teams_url": "https://api.github.com/repos/octo-org/hello-world/teams", - "trees_url": "https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}" - } - } - ] - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "alerts" - } - } - }, - "/orgs/{org}/dependabot/repository-access": { - "get": { - "summary": "Lists the repositories Dependabot can access in an organization", - "description": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/repository-access-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "in": "query", - "description": "The page number of results to fetch.", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "default": 1 - } - }, - { - "name": "per_page", - "in": "query", - "description": "Number of results per page.", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Dependabot Repository Access Details", - "description": "Information about repositories that Dependabot is able to access in an organization", - "type": "object", - "properties": { - "default_level": { - "type": [ - "string", - "null" - ], - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal", - null - ], - "examples": [ - "internal" - ] - }, - "accessible_repositories": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", + "string", "null" ] }, @@ -135644,382 +133981,546 @@ "type", "url" ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" ] - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + } + ] + }, + "assigning_team": { + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", + "oneOf": [ + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent", + "type" ] }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" + { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "description": "Retired: this field will not be returned with GHEC enterprise teams.", + "examples": [ + "disabled | all" + ] + }, + "organization_selection_type": { + "type": "string", + "examples": [ + "disabled | selected | all" + ] + }, + "group_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "62ab9291-fae2-468e-974b-7e45096d5021" + ] + }, + "group_name": { + "type": [ + "string", + "null" + ], + "description": "Retired: this field will not be returned with GHEC enterprise teams.", + "examples": [ + "Justice League" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/dc/teams/justice-league" + ] + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "name", + "html_url", + "slug", + "created_at", + "updated_at", + "group_id" ] } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" + ], + "type": [ + "null", + "object" + ] + }, + "pending_cancellation_date": { + "type": [ + "string", + "null" + ], + "format": "date", + "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." + }, + "last_activity_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + }, + "last_activity_editor": { + "type": [ + "string", + "null" + ], + "description": "Last editor that was used by the user for a GitHub Copilot completion." + }, + "last_authenticated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "deprecated": true, + "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise", + "unknown" ] } - ] + }, + "required": [ + "created_at" + ], + "additionalProperties": false } } - }, - "additionalProperties": false + } }, "examples": { "default": { "value": { - "default_level": "public", - "accessible_repositories": [ + "total_seats": 2, + "seats": [ { - "id": 123456, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", - "name": "example-repo", - "full_name": "octocat/example-repo", - "owner": { - "name": "octocat", - "email": "octo@github.com", + "created_at": "2021-08-03T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": null, + "last_activity_at": "2021-10-14T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "last_authenticated_at": "2021-10-14T00:53:32-06:00", + "plan_type": "business", + "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", - "gravatar_id": 1, + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat/example-repo", + "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", @@ -136030,57 +134531,117 @@ "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", - "site_admin": false, - "starred_at": "\"2020-07-09T00:17:55Z\"", - "user_view_type": "default" + "site_admin": false }, - "private": false, - "html_url": "https://github.com/octocat/example-repo", - "description": "This is an example repository.", - "fork": false, - "url": "https://api.github.com/repos/octocat/example-repo", - "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", - "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", - "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", - "events_url": "https://api.github.com/repos/octocat/example-repo/events", - "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", - "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", - "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", - "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", - "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", - "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", - "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", - "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", - "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + "assigning_team": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + }, + { + "created_at": "2021-09-23T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": "2021-11-01", + "last_activity_at": "2021-10-13T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "last_authenticated_at": "2021-10-14T00:53:32-06:00", + "assignee": { + "login": "octokitten", + "id": 1, + "node_id": "MDQ76VNlcjE=", + "avatar_url": "https://github.com/images/error/octokitten_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octokitten", + "html_url": "https://github.com/octokitten", + "followers_url": "https://api.github.com/users/octokitten/followers", + "following_url": "https://api.github.com/users/octokitten/following{/other_user}", + "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", + "organizations_url": "https://api.github.com/users/octokitten/orgs", + "repos_url": "https://api.github.com/users/octokitten/repos", + "events_url": "https://api.github.com/users/octokitten/events{/privacy}", + "received_events_url": "https://api.github.com/users/octokitten/received_events", + "type": "User", + "site_admin": false + } } ] } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } } }, "403": { @@ -136139,20 +134700,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "copilot", + "subcategory": "copilot-user-management" } - }, - "patch": { - "summary": "Updates Dependabot's repository access list for an organization", - "description": "Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.\n\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", + } + }, + "/orgs/{org}/copilot/billing/selected_teams": { + "post": { + "summary": "Add teams to the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/update-repository-access-for-org", + "operationId": "copilot/add-copilot-seats-for-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization" }, "parameters": [ { @@ -136166,65 +134729,117 @@ } ], "requestBody": { - "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "repository_ids_to_add": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "List of repository IDs to add." - }, - "repository_ids_to_remove": { + "selected_teams": { "type": "array", + "description": "List of team names within the organization to which to grant access to GitHub Copilot.", "items": { - "type": "integer" + "type": "string" }, - "description": "List of repository IDs to remove." + "minItems": 1 } }, - "example": { - "repository_ids_to_add": [ - 123, - 456 - ], - "repository_ids_to_remove": [ - 789 - ] - } + "required": [ + "selected_teams" + ] }, "examples": { - "204": { - "summary": "Example with a 'succeeded' status." - }, - "add-example": { - "summary": "Add repositories", - "value": { - "repository_ids_to_add": [ - 123, - 456 - ] - } - }, - "remove-example": { - "summary": "Remove repositories", + "default": { "value": { - "repository_ids_to_remove": [ - 789 + "selected_teams": [ + "engteam1", + "engteam2", + "engteam3" ] } } } } - } + }, + "required": true }, "responses": { - "204": { - "description": "Response" + "201": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The total number of seats created for members of the specified team(s).", + "properties": { + "seats_created": { + "type": "integer" + } + }, + "required": [ + "seats_created" + ] + }, + "examples": { + "default": { + "value": { + "seats_created": 5 + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } }, "403": { "description": "Forbidden", @@ -136277,27 +134892,28 @@ } } } + }, + "422": { + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "copilot", + "subcategory": "copilot-user-management" } - } - }, - "/orgs/{org}/dependabot/repository-access/default-level": { - "put": { - "summary": "Set the default repository access level for Dependabot", - "description": "Sets the default level of repository access Dependabot will have while performing an update. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.\n\nThis operation supports both server-to-server and user-to-server access.", + }, + "delete": { + "summary": "Remove teams from the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/set-repository-access-default-level", + "operationId": "copilot/cancel-copilot-seat-assignment-for-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization" }, "parameters": [ { @@ -136311,42 +134927,117 @@ } ], "requestBody": { - "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "default_level": { - "type": "string", - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal" - ], - "examples": [ - "internal" - ] + "selected_teams": { + "type": "array", + "description": "The names of teams from which to revoke access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 } }, "required": [ - "default_level" + "selected_teams" ] }, "examples": { - "204": { - "summary": "Example with a 'succeeded' status.", + "default": { "value": { - "default_level": "public" + "selected_teams": [ + "engteam1", + "engteam2", + "engteam3" + ] } } } } - } + }, + "required": true }, "responses": { - "204": { - "description": "Response" + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", + "properties": { + "seats_cancelled": { + "type": "integer" + } + }, + "required": [ + "seats_cancelled" + ] + }, + "examples": { + "default": { + "value": { + "seats_cancelled": 5 + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } }, "403": { "description": "Forbidden", @@ -136399,27 +135090,30 @@ } } } + }, + "422": { + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "copilot", + "subcategory": "copilot-user-management" } } }, - "/orgs/{org}/dependabot/secrets": { - "get": { - "summary": "List organization secrets", - "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "/orgs/{org}/copilot/billing/selected_users": { + "post": { + "summary": "Add users to the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/list-org-secrets", + "operationId": "copilot/add-copilot-seats-for-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#list-organization-secrets" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization" }, "parameters": [ { @@ -136430,149 +135124,194 @@ "schema": { "type": "string" } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members to be granted access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "selected_usernames" + ] + }, + "examples": { + "default": { + "value": { + "selected_usernames": [ + "cooluser1", + "hacker2", + "octocat" + ] + } + } + } + } + }, + "required": true + }, "responses": { - "200": { - "description": "Response", + "201": { + "description": "OK", "content": { "application/json": { "schema": { "type": "object", - "required": [ - "total_count", - "secrets" - ], + "description": "The total number of seats created for the specified user(s).", "properties": { - "total_count": { + "seats_created": { "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "title": "Dependabot Secret for an Organization", - "description": "Secrets for GitHub Dependabot for an organization.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" - ] - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - } } - } + }, + "required": [ + "seats_created" + ] }, "examples": { "default": { "value": { - "total_count": 3, - "secrets": [ - { - "name": "MY_ARTIFACTORY_PASSWORD", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2021-12-10T14:59:22Z", - "visibility": "private" - }, - { - "name": "NPM_TOKEN", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2021-12-10T14:59:22Z", - "visibility": "all" - }, - { - "name": "GH_TOKEN", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2021-12-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories" - } - ] + "seats_created": 5 } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } } } } + }, + "422": { + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-user-management" } - } - }, - "/orgs/{org}/dependabot/secrets/public-key": { - "get": { - "summary": "Get an organization public key", - "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + }, + "delete": { + "summary": "Remove users from the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/get-org-public-key", + "operationId": "copilot/cancel-copilot-seat-assignment-for-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization" }, "parameters": [ { @@ -136585,67 +135324,194 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members for which to revoke access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "selected_usernames" + ] + }, + "examples": { + "default": { + "value": { + "selected_usernames": [ + "cooluser1", + "hacker2", + "octocat" + ] + } + } + } + } + }, + "required": true + }, "responses": { "200": { - "description": "Response", + "description": "OK", "content": { "application/json": { "schema": { - "title": "DependabotPublicKey", - "description": "The public key used for setting Dependabot Secrets.", "type": "object", + "description": "The total number of seats set to \"pending cancellation\" for the specified users.", "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string", - "examples": [ - "1234567" - ] - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "examples": [ - "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" - ] + "seats_cancelled": { + "type": "integer" } }, "required": [ - "key_id", - "key" + "seats_cancelled" ] }, "examples": { "default": { "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + "seats_cancelled": 5 + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } + }, + "422": { + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-user-management" } } }, - "/orgs/{org}/dependabot/secrets/{secret_name}": { + "/orgs/{org}/copilot/coding-agent/permissions": { "get": { - "summary": "Get an organization secret", - "description": "Gets a single organization secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Get Copilot cloud agent permissions for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about which repositories in an organization have been enabled\nor disabled for the Copilot cloud agent.\n\nOrganization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/get-org-secret", + "operationId": "copilot/get-copilot-coding-agent-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-cloud-agent-permissions-for-an-organization" }, "parameters": [ { @@ -136656,15 +135522,6 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "responses": { @@ -136673,57 +135530,148 @@ "content": { "application/json": { "schema": { - "title": "Dependabot Secret for an Organization", - "description": "Secrets for GitHub Dependabot for an organization.", "type": "object", "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { + "enabled_repositories": { "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a secret", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", - "private", - "selected" - ], - "type": "string" + "selected", + "none" + ] }, "selected_repositories_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" - ] + "description": "The URL for the selected repositories endpoint. Only present when `enabled_repositories` is `selected`." } }, "required": [ - "name", - "created_at", - "updated_at", - "visibility" + "enabled_repositories" ] }, "examples": { - "default": { + "all_enabled": { + "summary": "All repositories enabled", "value": { - "name": "NPM_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories" + "enabled_repositories": "all" + } + }, + "selected_enabled": { + "summary": "Selected repositories enabled", + "value": { + "enabled_repositories": "selected", + "selected_repositories_url": "https://api.github.com/orgs/my-org/copilot/coding-agent/permissions/repositories" + } + }, + "none_enabled": { + "summary": "No repositories enabled", + "value": { + "enabled_repositories": "none" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -136734,20 +135682,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-coding-agent-management" } }, "put": { - "summary": "Create or update an organization secret", - "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Set Copilot cloud agent permissions for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets the policy for which repositories in an organization can use Copilot cloud agent.\n\nOrganization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/create-or-update-org-secret", + "operationId": "copilot/set-copilot-coding-agent-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-cloud-agent-permissions-for-an-organization" }, "parameters": [ { @@ -136758,15 +135706,6 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { @@ -136776,53 +135715,24 @@ "schema": { "type": "object", "properties": { - "encrypted_value": { - "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint.", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "type": "string", - "description": "ID of the key you used to encrypt the secret." - }, - "visibility": { + "enabled_repositories": { "type": "string", - "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ "all", - "private", - "selected" + "selected", + "none" ] - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", - "items": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "string" - } - ] - } } }, "required": [ - "visibility" + "enabled_repositories" ] }, "examples": { "default": { "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] + "enabled_repositories": "selected" } } } @@ -136830,106 +135740,208 @@ } }, "responses": { - "201": { - "description": "Response when creating a secret", + "204": { + "description": "No Content" + }, + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } } } } }, - "204": { - "description": "Response when updating a secret" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - }, - "x-github-breaking-changes": [ - { - "changeset": "remove_string_type_from_repo_id_param", - "patch": [ - { - "op": "replace", - "path": "/requestBody/content/application~1json/schema/properties/selected_repository_ids/items", - "value": { - "type": "integer" + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } } } - ], - "version": "2026-03-10" - } - ] - }, - "delete": { - "summary": "Delete an organization secret", - "description": "Deletes a secret in an organization using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/delete-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" } }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } } - } - ], - "responses": { - "204": { - "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-coding-agent-management" } } }, - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { + "/orgs/{org}/copilot/coding-agent/permissions/repositories": { "get": { - "summary": "List selected repositories for an organization secret", - "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "List repositories enabled for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists the selected repositories that are enabled for Copilot cloud agent in an organization.\n\nOrganization owners can use this endpoint when the coding agent repository policy\nis set to `selected` to see which repositories have been enabled.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/list-selected-repos-for-org-secret", + "operationId": "copilot/list-copilot-coding-agent-selected-repositories-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -136942,12 +135954,12 @@ } }, { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 30 } }, { @@ -136958,15 +135970,6 @@ "type": "integer", "default": 1 } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } } ], "responses": { @@ -136976,10 +135979,6 @@ "application/json": { "schema": { "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { "total_count": { "type": "integer" @@ -137929,7 +136928,11 @@ ] } } - } + }, + "required": [ + "total_count", + "repositories" + ] }, "examples": { "default": { @@ -138003,7 +137006,179 @@ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "organization": null, + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 } ] } @@ -138011,25 +137186,155 @@ } } } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-coding-agent-management" } }, "put": { - "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Set selected repositories for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReplaces the list of selected repositories that are enabled for Copilot cloud\nagent in an organization. This method can only be called when the cloud agent\nrepository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/set-selected-repos-for-org-secret", + "operationId": "copilot/set-copilot-coding-agent-selected-repositories-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -138040,15 +137345,6 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { @@ -138059,10 +137355,11 @@ "type": "object", "properties": { "selected_repository_ids": { + "description": "List of repository IDs to enable for Copilot cloud agent.", "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { - "type": "integer" + "type": "integer", + "description": "Unique identifier of the repository." } } }, @@ -138074,7 +137371,8 @@ "default": { "value": { "selected_repository_ids": [ - 64780797 + 32, + 42 ] } } @@ -138084,28 +137382,233 @@ }, "responses": { "204": { - "description": "Response" + "description": "No Content" + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-coding-agent-management" } } }, - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}": { "put": { - "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Enable a repository for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nAdds a repository to the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/add-selected-repo-to-org-secret", + "operationId": "copilot/enable-copilot-coding-agent-for-repository-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -138117,17 +137620,9 @@ "type": "string" } }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, { "name": "repository_id", + "description": "The unique identifier of the repository.", "in": "path", "required": true, "schema": { @@ -138137,29 +137632,231 @@ ], "responses": { "204": { - "description": "No Content when repository was added to the selected list" + "description": "No Content" + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } }, "409": { - "description": "Conflict when visibility type is not set to selected" + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-coding-agent-management" } }, "delete": { - "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Disable a repository for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemoves a repository from the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/remove-selected-repo-from-org-secret", + "operationId": "copilot/disable-copilot-coding-agent-for-repository-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -138172,50 +137869,609 @@ } }, { - "name": "secret_name", - "description": "The name of the secret.", + "name": "repository_id", + "description": "The unique identifier of the repository.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } } }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-coding-agent-management" + } + } + }, + "/orgs/{org}/copilot/content_exclusion": { + "get": { + "summary": "Get Copilot content exclusion rules for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot content exclusion path rules.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can view details about Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `copilot` or `read:org` scopes to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.\n> * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-content-exclusion-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization" + }, + "parameters": [ { - "name": "repository_id", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], "responses": { - "204": { - "description": "Response when repository was removed from the selected list" + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "title": "Copilot Organization Content Exclusion Details", + "description": "List all Copilot Content Exclusion rules for an organization.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string", + "description": "The path to the file that will be excluded." + } + } + }, + "examples": { + "default": { + "value": { + "octo-repo": [ + "/src/some-dir/kernel.rs" + ] + } + } + } + } + } }, - "409": { - "description": "Conflict when visibility type not set to selected" + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-content-exclusion-management" + } + }, + "put": { + "summary": "Set Copilot content exclusion rules for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets Copilot content exclusion path rules for an organization.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can set Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.\n> * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.", + "tags": [ + "copilot" + ], + "operationId": "copilot/set-copilot-content-exclusion-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The content exclusion rules to set", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string", + "description": "The path to the file that will be excluded." + }, + { + "type": "object", + "properties": { + "ifAnyMatch": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "ifAnyMatch" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ifNoneMatch": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "ifNoneMatch" + ], + "additionalProperties": false + } + ] + } + } + }, + "examples": { + "default": { + "summary": "Example of content exclusion paths", + "value": { + "octo-repo": [ + "/src/some-dir/kernel.rs" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Content exclusion rules updated successfully." + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "413": { + "description": "Payload Too Large", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": null, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-content-exclusion-management" } } }, - "/orgs/{org}/docker/conflicts": { + "/orgs/{org}/copilot/metrics": { "get": { - "summary": "Get list of conflicting packages during Docker migration for organization", - "description": "Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", + "summary": "Get Copilot metrics for an organization", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", "tags": [ - "packages" + "copilot" ], - "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", + "operationId": "copilot/copilot-metrics-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" }, "parameters": [ { @@ -138226,6 +138482,42 @@ "schema": { "type": "string" } + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 100 + } } ], "responses": { @@ -138236,1277 +138528,475 @@ "schema": { "type": "array", "items": { - "title": "Package", - "description": "A software package", + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the package.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the package.", - "type": "string", - "examples": [ - "super-linter" - ] - }, - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ], - "examples": [ - "docker" - ] - }, - "url": { + "date": { "type": "string", - "examples": [ - "https://api.github.com/orgs/github/packages/container/super-linter" - ] + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." }, - "html_url": { - "type": "string", - "examples": [ - "https://github.com/orgs/github/packages/container/package/super-linter" - ] + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." }, - "version_count": { - "description": "The number of versions of the package.", + "total_engaged_users": { "type": "integer", - "examples": [ - 1 - ] + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." }, - "visibility": { - "type": "string", - "enum": [ - "private", - "public" + "copilot_ide_code_completions": { + "type": [ + "object", + "null" ], - "examples": [ - "private" - ] + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } }, - "owner": { - "anyOf": [ - { - "type": "null" + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + } } - ] + } }, - "repository": { - "anyOf": [ - { - "type": "null" + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in GitHub.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." }, - { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_bypass": { + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { "type": "object", "properties": { - "status": { + "name": { "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - }, - "mode": { - "type": "string", - "description": "The bypass mode for the reviewer", - "enum": [ - "ALWAYS", - "EXEMPT" - ], - "default": "ALWAYS" - } - } - } + "description": "Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." } } } } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ], - "x-github-breaking-changes": [ - { - "changeset": "remove_has_downloads", - "patch": { - "properties": { - "has_downloads": null - } - }, - "version": "2026-03-10" } - ] + } } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" + } } }, "required": [ - "id", - "name", - "package_type", - "visibility", - "url", - "html_url", - "version_count", - "created_at", - "updated_at" - ] + "date" + ], + "additionalProperties": true } }, "examples": { "default": { "value": [ { - "id": 197, - "name": "hello_docker", - "package_type": "container", - "owner": { - "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 + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] }, - "version_count": 1, - "visibility": "private", - "url": "https://api.github.com/orgs/github/packages/container/hello_docker", - "created_at": "2020-05-19T22:19:11Z", - "updated_at": "2020-05-19T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" - }, - { - "id": 198, - "name": "goodbye_docker", - "package_type": "container", - "owner": { - "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 + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] }, - "version_count": 2, - "visibility": "private", - "url": "https://api.github.com/orgs/github/packages/container/goodbye_docker", - "created_at": "2020-05-20T22:19:11Z", - "updated_at": "2020-05-20T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/package/goodbye_docker" + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } } ] } @@ -139514,6 +139004,32 @@ } } }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, "403": { "description": "Forbidden", "content": { @@ -139540,8 +139056,34 @@ } } }, - "401": { - "description": "Requires authentication", + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Copilot Usage Metrics API setting is disabled at the organization or enterprise level.", "content": { "application/json": { "schema": { @@ -139569,23 +139111,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "packages", - "subcategory": "packages" + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" } } }, - "/orgs/{org}/events": { + "/orgs/{org}/copilot/metrics/reports/organization-1-day": { "get": { - "summary": "List public organization events", - "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", + "summary": "Get Copilot organization usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", "tags": [ - "activity" + "copilot" ], - "operationId": "activity/list-public-org-events", + "operationId": "copilot/copilot-organization-one-day-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/activity/events#list-public-organization-events" + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day" }, "parameters": [ { @@ -139598,21 +139140,172 @@ } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", "in": "query", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + } + } + } + } + }, + "204": { + "description": "A header with no content is returned." + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } } }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest": { + "get": { + "summary": "Get Copilot organization usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics" + }, + "parameters": [ { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "string" } } ], @@ -139622,4846 +139315,3069 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Event", - "description": "Event", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": [ - "string", - "null" - ] - }, - "actor": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "name", - "url" - ] + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/users-1-day": { + "get": { + "summary": "Get Copilot organization users usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-users-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" }, - "org": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + } + } + } + } + }, + "204": { + "description": "A header with no content is returned." + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/users-28-day/latest": { + "get": { + "summary": "Get Copilot organization users usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-users-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" }, - "payload": { - "oneOf": [ - { - "title": "CreateEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "full_ref": { - "type": "string" - }, - "master_branch": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "full_ref", - "master_branch", - "pusher_type" - ] - }, - { - "title": "DeleteEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "full_ref": { - "type": "string" - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "full_ref", - "pusher_type" - ] - }, - { - "title": "DiscussionEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "discussion": { - "title": "Discussion", - "description": "A Discussion in a repository.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/dependabot/alerts": { + "get": { + "summary": "List Dependabot alerts for an organization", + "description": "Lists Dependabot alerts for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/list-alerts-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "classification", + "in": "query", + "description": "A comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned.\n\nCan be: `malware`, `general`", + "schema": { + "type": "string" + } + }, + { + "name": "state", + "in": "query", + "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`", + "schema": { + "type": "string" + } + }, + { + "name": "severity", + "in": "query", + "description": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`", + "schema": { + "type": "string" + } + }, + { + "name": "ecosystem", + "in": "query", + "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`", + "schema": { + "type": "string" + } + }, + { + "name": "package", + "in": "query", + "description": "A comma-separated list of package names. If specified, only alerts for these packages will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentage", + "in": "query", + "description": "CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "artifact_registry_url", + "in": "query", + "description": "A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "artifact_registry", + "in": "query", + "description": "A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned.\n\nCan be: `jfrog-artifactory`", + "schema": { + "type": "string" + } + }, + { + "name": "has", + "in": "query", + "description": "Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple `has` filters can be passed to filter for alerts that have all of the values.", + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "patch", + "deployment" + ] + } + } + ] + } + }, + { + "name": "assignee", + "in": "query", + "description": "Filter alerts by assignees.\nProvide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users.\nUse `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.", + "schema": { + "type": "string" + } + }, + { + "name": "runtime_risk", + "in": "query", + "description": "A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned.\n\nCan be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement`", + "schema": { + "type": "string" + } + }, + { + "name": "scope", + "in": "query", + "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.", + "schema": { + "type": "string", + "enum": [ + "development", + "runtime" + ] + } + }, + { + "name": "sort", + "in": "query", + "description": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.", + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "epss_percentage" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "description": "A Dependabot alert.", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "state": { + "type": "string", + "description": "The state of the Dependabot alert.", + "readOnly": true, + "enum": [ + "auto_dismissed", + "dismissed", + "fixed", + "open" + ] + }, + "dependency": { + "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true + }, + "scope": { + "type": [ + "string", + "null" + ], + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "enum": [ + "development", + "runtime", + null + ] + }, + "relationship": { + "type": [ + "string", + "null" + ], + "description": "The vulnerable dependency's relationship to your project.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.\n", + "readOnly": true, + "enum": [ + "unknown", + "direct", + "transitive", + "inconclusive", + null + ] + } + } + }, + "security_advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { + "type": "string", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true + }, + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true + }, + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true }, - "required": [ - "login", - "id" - ] + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } }, - "answer_html_url": { + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + } + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "classification": { + "type": "string", + "description": "The classification of the advisory.", + "readOnly": true, + "enum": [ + "general", + "malware" + ] + }, + "cvss": { + "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, + "properties": { + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true + }, + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The full CVSS vector string for the advisory.", + "readOnly": true + } + }, + "required": [ + "score", + "vector_string" + ], + "additionalProperties": false + }, + "cvss_severities": { + "type": [ + "object", + "null" + ], + "properties": { + "cvss_v3": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { "type": [ "string", "null" - ] - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] - }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "locked": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" - }, - "state": { - "type": "string", - "description": "The current state of the discussion.\n`converting` means that the discussion is being converted from an issue.\n`transferring` means that the discussion is being transferred from another repository.", - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] + ], + "description": "The CVSS 3 vector string." }, - "state_reason": { - "description": "The reason for the current state", + "score": { "type": [ - "string", + "number", "null" ], - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" ], - "examples": [ - "resolved" - ] - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" + "description": "The CVSS 4 vector string." }, - "user": { - "title": "User", + "score": { "type": [ - "object", + "number", "null" ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64", - "examples": [ - 208045946 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDU6TGFiZWwyMDgwNDU5NDY=" - ] - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/labels/bug" - ] - }, - "name": { - "description": "The name of the label.", - "type": "string", - "examples": [ - "bug" - ] - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ], - "examples": [ - "Something isn't working" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string", - "examples": [ - "FFFFFF" - ] - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "examples": [ - true - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "readOnly": true } }, "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "state_reason", - "locked", - "comments", - "created_at", - "updated_at", - "active_lock_reason", - "body" + "vector_string", + "score" ] } + } + }, + "epss": { + "type": [ + "object", + "null" + ], + "readOnly": true, + "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", + "properties": { + "percentage": { + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "percentile": { + "type": "number", + "minimum": 0, + "maximum": 100 + } + } + }, + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } + }, + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + } + }, + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } + }, + "required": [ + "url" + ], + "additionalProperties": false + } + }, + "published_at": { + "type": "string", + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + }, + "required": [ + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" + ], + "additionalProperties": false, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": { + "properties": { + "cvss": null + }, + "required": [ + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" + ] + }, + "version": "2026-03-10" + } + ] + }, + "security_vulnerability": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } }, "required": [ - "action", - "discussion" + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" ] }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" + }, { - "title": "IssuesEvent", + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "action": { - "type": "string" + "name": { + "type": [ + "string", + "null" + ] }, - "issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/1" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], - "examples": [ - "not_planned" - ] - }, - "title": { - "description": "Title of the issue", - "type": "string", - "examples": [ - "Widget creation fails in Safari on OS X 10.8" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ], - "examples": [ - "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - }, - "examples": [ - "bug", - "registration" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ] - } + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "dismissed_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason that the alert was dismissed.", + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment associated with the alert's dismissal.", + "maxLength": 280 + }, + "fixed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "auto_dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissal_request": { + "title": "Dependabot alert dismissal request", + "description": "Information about an active dismissal request for this Dependabot alert.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the dismissal request." + }, + "status": { + "type": "string", + "description": "The current status of the dismissal request.", + "enum": [ + "pending", + "approved", + "rejected", + "cancelled" + ] + }, + "requester": { + "type": "object", + "description": "The user who requested the dismissal.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the user." + }, + "login": { + "type": "string", + "description": "The login name of the user." + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time when the dismissal request was created." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The API URL to get more information about this dismissal request." + } + } + }, + "assignees": { + "type": "array", + "description": "The users assigned to this alert.", + "readOnly": true, + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } + }, + "required": [ + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", + "url", + "html_url", + "created_at", + "updated_at", + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at", + "repository" + ], + "additionalProperties": false + } + }, + "examples": { + "default": { + "value": [ + { + "number": 2, + "state": "dismissed", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-rf4j-j272-fj86", + "cve_id": "CVE-2018-6188", + "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", + "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 1.11.8, < 1.11.10", + "first_patched_version": { + "identifier": "1.11.10" + } + } + ], + "severity": "high", + "cvss": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, + "cwes": [ + { + "cwe_id": "CWE-200", + "name": "Exposure of Sensitive Information to an Unauthorized Actor" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-rf4j-j272-fj86" + }, + { + "type": "CVE", + "value": "CVE-2018-6188" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" + }, + { + "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" + }, + { + "url": "https://usn.ubuntu.com/3559-1/" + }, + { + "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" + }, + { + "url": "http://www.securitytracker.com/id/1040422" + } + ], + "published_at": "2018-10-03T21:13:54Z", + "updated_at": "2022-04-26T18:35:37Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + "url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2", + "html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2", + "created_at": "2022-06-15T07:43:03Z", + "updated_at": "2022-08-23T14:29:47Z", + "dismissed_at": "2022-08-23T14:29:47Z", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_reason": "tolerable_risk", + "dismissed_comment": "This alert is accurate but we use a sanitizer.", + "fixed_at": null, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "repository": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "owner": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "private": true, + "html_url": "https://github.com/octo-org/octo-repo", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}" + } + }, + { + "number": 1, + "state": "open", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-8f4m-hccc-8qph", + "cve_id": "CVE-2021-20191", + "summary": "Insertion of Sensitive Information into Log File in ansible", + "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.9.0, < 2.9.18", + "first_patched_version": { + "identifier": "2.9.18" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.10.0, < 2.10.7", + "first_patched_version": { + "identifier": "2.10.7" + } + } + ], + "severity": "medium", + "cvss": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, + "cwes": [ + { + "cwe_id": "CWE-532", + "name": "Insertion of Sensitive Information into Log File" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-8f4m-hccc-8qph" + }, + { + "type": "CVE", + "value": "CVE-2021-20191" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" + }, + { + "url": "https://access.redhat.com/security/cve/cve-2021-20191" + }, + { + "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" + } + ], + "published_at": "2021-06-01T17:38:00Z", + "updated_at": "2021-08-12T23:06:00Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + "url": "https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1", + "html_url": "https://github.com/octo-org/hello-world/security/dependabot/1", + "created_at": "2022-06-14T15:21:52Z", + "updated_at": "2022-06-14T15:21:52Z", + "dismissed_at": null, + "dismissed_by": null, + "dismissed_reason": null, + "dismissed_comment": null, + "fixed_at": null, + "assignees": [], + "repository": { + "id": 664700648, + "node_id": "MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=", + "name": "hello-world", + "full_name": "octo-org/hello-world", + "owner": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "private": true, + "html_url": "https://github.com/octo-org/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/hello-world", + "archive_url": "https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/hello-world/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/hello-world/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/hello-world/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/hello-world/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/hello-world/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/hello-world/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/hello-world/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/hello-world/downloads", + "events_url": "https://api.github.com/repos/octo-org/hello-world/events", + "forks_url": "https://api.github.com/repos/octo-org/hello-world/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/hello-world/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/hello-world/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/hello-world/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/hello-world/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/hello-world/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/hello-world/languages", + "merges_url": "https://api.github.com/repos/octo-org/hello-world/merges", + "milestones_url": "https://api.github.com/repos/octo-org/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/hello-world/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/hello-world/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/hello-world/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/hello-world/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/hello-world/subscription", + "tags_url": "https://api.github.com/repos/octo-org/hello-world/tags", + "teams_url": "https://api.github.com/repos/octo-org/hello-world/teams", + "trees_url": "https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}" + } + } + ] + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "alerts" + } + } + }, + "/orgs/{org}/dependabot/repository-access": { + "get": { + "summary": "Lists the repositories Dependabot can access in an organization", + "description": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/repository-access-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "in": "query", + "description": "The page number of results to fetch.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "default": 1 + } + }, + { + "name": "per_page", + "in": "query", + "description": "Number of results per page.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", + "type": "object", + "properties": { + "default_level": { + "type": [ + "string", + "null" + ], + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal", + null + ], + "examples": [ + "internal" + ] + }, + "accessible_repositories": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { + "email": { "type": [ "string", "null" ] }, - "comments": { - "type": "integer" + "login": { + "type": "string", + "examples": [ + "octocat" + ] }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 ] }, - "closed_at": { + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ "string", "null" ], - "format": "date-time" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "created_at": { + "url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "draft": { - "type": "boolean" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "timeline_url": { + "starred_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" ] }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ], - "examples": [ - "all" - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ], - "x-github-breaking-changes": [ - { - "changeset": "remove_use_squash_pr_title_as_default", - "patch": { - "properties": { - "use_squash_pr_title_as_default": null - } - }, - "version": "2026-03-10" - }, - { - "changeset": "deprecate_beta_media_type", - "patch": { - "properties": { - "master_branch": null - } - }, - "version": "2026-03-10" - }, - { - "changeset": "remove_has_downloads", - "patch": { - "properties": { - "has_downloads": null - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "version": "2026-03-10" - } + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" ] }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" ] }, - "author_association": { - "title": "author_association", + "events_url": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], "examples": [ - "OWNER" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" ] }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" + "type": { + "type": "string", + "examples": [ + "User" ] }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the issue comment", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/comments/1" - ] - }, - "body": { - "description": "Contents of the issue comment", - "type": "string", - "examples": [ - "What version of Safari were you using when you observed this bug?" - ] - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] - }, - { - "type": "number", - "examples": [ - 42.5 - ] - }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] - }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "required": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "created_at", - "updated_at" - ], - "x-github-breaking-changes": [ - { - "changeset": "deprecate_beta_media_type", - "patch": { - "properties": { - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "nullable": false - }, - "diff_url": { - "nullable": false - }, - "html_url": { - "nullable": false - }, - "patch_url": { - "nullable": false - }, - "url": { - "nullable": false - } - } - } - } - }, - "version": "2026-03-10" - }, - { - "changeset": "remove_singular_assignee_from_issues_and_pull_requests", - "patch": { - "properties": { - "assignee": null - }, - "required": [ - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "created_at", - "updated_at" - ] - }, - "version": "2026-03-10" - } - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" + "site_admin": { + "type": "boolean" }, "starred_at": { "type": "string", @@ -144497,1760 +142413,4983 @@ "url" ] }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "private": { + "type": "boolean", + "description": "Whether the repository is private." }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64", - "examples": [ - 208045946 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDU6TGFiZWwyMDgwNDU5NDY=" - ] - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/labels/bug" - ] - }, - "name": { - "description": "The name of the label.", - "type": "string", - "examples": [ - "bug" - ] - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ], - "examples": [ - "Something isn't working" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string", - "examples": [ - "FFFFFF" - ] - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "examples": [ - true - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" ] }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64", - "examples": [ - 208045946 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDU6TGFiZWwyMDgwNDU5NDY=" - ] - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/labels/bug" - ] - }, - "name": { - "description": "The name of the label.", - "type": "string", - "examples": [ - "bug" - ] - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ], - "examples": [ - "Something isn't working" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string", - "examples": [ - "FFFFFF" - ] - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "examples": [ - true - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] } }, "required": [ - "action", - "issue" + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] + } + ] + } + } + }, + "additionalProperties": false + }, + "examples": { + "default": { + "value": { + "default_level": "public", + "accessible_repositories": [ + { + "id": 123456, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", + "name": "example-repo", + "full_name": "octocat/example-repo", + "owner": { + "name": "octocat", + "email": "octo@github.com", + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", + "gravatar_id": 1, + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat/example-repo", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "starred_at": "\"2020-07-09T00:17:55Z\"", + "user_view_type": "default" }, - { - "title": "IssueCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/1" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], - "examples": [ - "not_planned" - ] - }, - "title": { - "description": "Title of the issue", - "type": "string", - "examples": [ - "Widget creation fails in Safari on OS X 10.8" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ], - "examples": [ - "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - }, - "examples": [ - "bug", - "registration" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "private": false, + "html_url": "https://github.com/octocat/example-repo", + "description": "This is an example repository.", + "fork": false, + "url": "https://api.github.com/repos/octocat/example-repo", + "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", + "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", + "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", + "events_url": "https://api.github.com/repos/octocat/example-repo/events", + "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", + "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", + "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", + "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", + "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", + "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", + "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + } + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" + } + }, + "patch": { + "summary": "Updates Dependabot's repository access list for an organization", + "description": "Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.\n\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/update-repository-access-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repository_ids_to_add": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to add." + }, + "repository_ids_to_remove": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to remove." + } + }, + "example": { + "repository_ids_to_add": [ + 123, + 456 + ], + "repository_ids_to_remove": [ + 789 + ] + } + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status." + }, + "add-example": { + "summary": "Add repositories", + "value": { + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, + "/orgs/{org}/dependabot/repository-access/default-level": { + "put": { + "summary": "Set the default repository access level for Dependabot", + "description": "Sets the default level of repository access Dependabot will have while performing an update. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.\n\nThis operation supports both server-to-server and user-to-server access.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/set-repository-access-default-level", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "examples": [ + "internal" + ] + } + }, + "required": [ + "default_level" + ] + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status.", + "value": { + "default_level": "public" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, + "/orgs/{org}/dependabot/secrets": { + "get": { + "summary": "List organization secrets", + "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/list-org-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#list-organization-secrets" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "title": "Dependabot Secret for an Organization", + "description": "Secrets for GitHub Dependabot for an organization.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" + ] + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 3, + "secrets": [ + { + "name": "MY_ARTIFACTORY_PASSWORD", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "private" + }, + { + "name": "NPM_TOKEN", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "GH_TOKEN", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/dependabot/secrets/public-key": { + "get": { + "summary": "Get an organization public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "DependabotPublicKey", + "description": "The public key used for setting Dependabot Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "examples": [ + "1234567" + ] + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "examples": [ + "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + ] + } + }, + "required": [ + "key_id", + "key" + ] + }, + "examples": { + "default": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/dependabot/secrets/{secret_name}": { + "get": { + "summary": "Get an organization secret", + "description": "Gets a single organization secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/get-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Dependabot Secret for an Organization", + "description": "Secrets for GitHub Dependabot for an organization.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" + ] + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "NPM_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/create-or-update-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + }, + "visibility": { + "type": "string", + "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + }, + "required": [ + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_string_type_from_repo_id_param", + "patch": [ + { + "op": "replace", + "path": "/requestBody/content/application~1json/schema/properties/selected_repository_ids/items", + "value": { + "type": "integer" + } + } + ], + "version": "2026-03-10" + } + ] + }, + "delete": { + "summary": "Delete an organization secret", + "description": "Deletes a secret in an organization using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/delete-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { + "get": { + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/list-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "has_pull_requests": { + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" ] - }, - "assignees": { + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "properties": { + "reviewers": { "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", "items": { - "title": "Simple User", - "description": "A GitHub user.", "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { + "reviewer_id": { "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "description": "The ID of the team or role selected as a bypass reviewer" }, - "node_id": { + "reviewer_type": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" ] }, - "avatar_url": { + "mode": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" + "description": "The bypass mode for the reviewer", + "enum": [ + "ALWAYS", + "EXEMPT" ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "default": "ALWAYS" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ] } + } + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": { + "properties": { + "has_downloads": null + } + }, + "version": "2026-03-10" + } + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Set selected repositories for an organization secret", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/set-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization secret", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/add-selected-repo-to-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "No Content when repository was added to the selected list" + }, + "409": { + "description": "Conflict when visibility type is not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Remove selected repository from an organization secret", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/remove-selected-repo-from-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response when repository was removed from the selected list" + }, + "409": { + "description": "Conflict when visibility type not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/docker/conflicts": { + "get": { + "summary": "Get list of conflicting packages during Docker migration for organization", + "description": "Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", + "tags": [ + "packages" + ], + "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Package", + "description": "A software package", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the package.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the package.", + "type": "string", + "examples": [ + "super-linter" + ] + }, + "package_type": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ], + "examples": [ + "docker" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/packages/container/super-linter" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "https://github.com/orgs/github/packages/container/package/super-linter" + ] + }, + "version_count": { + "description": "The number of versions of the package.", + "type": "integer", + "examples": [ + 1 + ] + }, + "visibility": { + "type": "string", + "enum": [ + "private", + "public" + ], + "examples": [ + "private" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "repository": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { + "email": { "type": [ "string", "null" ] }, - "comments": { - "type": "integer" + "login": { + "type": "string", + "examples": [ + "octocat" + ] }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 ] }, - "closed_at": { + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ "string", "null" ], - "format": "date-time" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "created_at": { + "url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "draft": { - "type": "boolean" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "body_html": { - "type": "string" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "body_text": { - "type": "string" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "timeline_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, "type": { - "title": "Issue Type", - "description": "The type of issue.", + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "has_pull_requests": { + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { "type": [ - "object", + "string", "null" ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { + "status": { "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null + "enabled", + "disabled" ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] + } }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", + "code_security": { "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { + "status": { "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "enum": [ + "enabled", + "disabled" ] - }, - "name": { - "description": "The name of the repository.", + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", "type": "string", - "examples": [ - "Team Environment" + "enum": [ + "enabled", + "disabled" ] - }, - "full_name": { + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { "type": "string", - "examples": [ - "octocat/Hello-World" + "enum": [ + "enabled", + "disabled" ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + }, + "mode": { + "type": "string", + "description": "The bypass mode for the reviewer", + "enum": [ + "ALWAYS", + "EXEMPT" + ], + "default": "ALWAYS" + } } + } + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": { + "properties": { + "has_downloads": null + } + }, + "version": "2026-03-10" + } + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "name", + "package_type", + "visibility", + "url", + "html_url", + "version_count", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 197, + "name": "hello_docker", + "package_type": "container", + "owner": { + "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 + }, + "version_count": 1, + "visibility": "private", + "url": "https://api.github.com/orgs/github/packages/container/hello_docker", + "created_at": "2020-05-19T22:19:11Z", + "updated_at": "2020-05-19T22:19:11Z", + "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" + }, + { + "id": 198, + "name": "goodbye_docker", + "package_type": "container", + "owner": { + "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 + }, + "version_count": 2, + "visibility": "private", + "url": "https://api.github.com/orgs/github/packages/container/goodbye_docker", + "created_at": "2020-05-20T22:19:11Z", + "updated_at": "2020-05-20T22:19:11Z", + "html_url": "https://github.com/orgs/github/packages/container/package/goodbye_docker" + } + ] + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/orgs/{org}/events": { + "get": { + "summary": "List public organization events", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", + "tags": [ + "activity" + ], + "operationId": "activity/list-public-org-events", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/events#list-public-organization-events" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Event", + "description": "Event", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": [ + "string", + "null" + ] + }, + "actor": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "name", + "url" + ] + }, + "org": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] + }, + "payload": { + "oneOf": [ + { + "title": "CreateEvent", + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "ref_type": { + "type": "string" + }, + "full_ref": { + "type": "string" + }, + "master_branch": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "pusher_type": { + "type": "string" + } + }, + "required": [ + "ref", + "ref_type", + "full_ref", + "master_branch", + "pusher_type" + ] + }, + { + "title": "DeleteEvent", + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "ref_type": { + "type": "string" + }, + "full_ref": { + "type": "string" + }, + "pusher_type": { + "type": "string" + } + }, + "required": [ + "ref", + "ref_type", + "full_ref", + "pusher_type" + ] + }, + { + "title": "DiscussionEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "discussion": { + "title": "Discussion", + "description": "A Discussion in a repository.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" ] }, - "forks": { + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { "type": "integer" }, - "permissions": { + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "answer_html_url": { + "type": [ + "string", + "null" + ] + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "type": "string" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "description": "The current state of the discussion.\n`converting` means that the discussion is being converted from an issue.\n`transferring` means that the discussion is being transferred from another repository.", + "enum": [ + "open", + "closed", + "locked", + "converting", + "transferring" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "outdated", + "duplicate", + "reopened", + null + ], + "examples": [ + "resolved" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "examples": [ + 208045946 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDU6TGFiZWwyMDgwNDU5NDY=" + ] + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/labels/bug" + ] + }, + "name": { + "description": "The name of the label.", + "type": "string", + "examples": [ + "bug" + ] + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": [ + "string", + "null" + ], + "examples": [ + "Something isn't working" + ] + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string", + "examples": [ + "FFFFFF" + ] + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "state_reason", + "locked", + "comments", + "created_at", + "updated_at", + "active_lock_reason", + "body" + ] + } + }, + "required": [ + "action", + "discussion" + ] + }, + { + "title": "IssuesEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "admin": { - "type": "boolean" + "name": { + "type": [ + "string", + "null" + ] }, - "pull": { - "type": "boolean" + "email": { + "type": [ + "string", + "null" + ] }, - "triage": { - "type": "boolean" + "login": { + "type": "string", + "examples": [ + "octocat" + ] }, - "push": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] }, - "maintain": { + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, "required": [ - "admin", - "pull", - "push" + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] + } + ] + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -146417,45 +147556,1157 @@ "type", "url" ] + } + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "description": { + "diff_url": { "type": [ "string", "null" ], - "examples": [ - "This your first repo!" - ] + "format": "uri" }, - "fork": { - "type": "boolean" + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" }, - "assignees_url": { + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" @@ -148846,47 +151097,586 @@ } ] }, - "comment": { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { - "description": "Unique identifier of the issue comment", "type": "integer", "format": "int64", "examples": [ - 42 + 1 ] }, "node_id": { - "type": "string" + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, "url": { - "description": "URL for the issue comment", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repositories/42/issues/comments/1" + "https://api.github.com/users/octocat" ] }, - "body": { - "description": "Contents of the issue comment", + "html_url": { "type": "string", + "format": "uri", "examples": [ - "What version of Safari were you using when you observed this bug?" + "https://github.com/octocat" ] }, - "body_text": { + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "label": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "examples": [ + 208045946 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDU6TGFiZWwyMDgwNDU5NDY=" + ] + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/labels/bug" + ] + }, + "name": { + "description": "The name of the label.", + "type": "string", + "examples": [ + "bug" + ] + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": [ + "string", + "null" + ], + "examples": [ + "Something isn't working" + ] + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string", + "examples": [ + "FFFFFF" + ] + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "examples": [ + 208045946 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDU6TGFiZWwyMDgwNDU5NDY=" + ] + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/labels/bug" + ] + }, + "name": { + "description": "The name of the label.", + "type": "string", + "examples": [ + "bug" + ] + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": [ + "string", + "null" + ], + "examples": [ + "Something isn't working" + ] + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string", + "examples": [ + "FFFFFF" + ] + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + } + }, + "required": [ + "action", + "issue" + ] + }, + { + "title": "IssueCommentEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { "type": "string" }, - "body_html": { + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { "type": "string" }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, "html_url": { "type": "string", "format": "uri" }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + ] + }, "user": { "anyOf": [ { @@ -149062,517 +151852,480 @@ } ] }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, "examples": [ - "OWNER" + "bug", + "registration" ] }, - "performed_via_github_app": { + "assignee": { "anyOf": [ { "type": "null" }, { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { - "description": "Unique identifier of the GitHub app", "type": "integer", + "format": "int64", "examples": [ - 37 + 1 ] }, - "slug": { - "description": "The slug name of the GitHub app", + "node_id": { "type": "string", "examples": [ - "probot-owners" + "MDQ6VXNlcjE=" ] }, - "node_id": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "MDExOkludGVncmF0aW9uMQ==" + "https://github.com/images/error/octocat_happy.gif" ] }, - "client_id": { + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" + "https://api.github.com/users/octocat" ] }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" ] }, - "name": { - "description": "The name of the GitHub app", + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "Probot Owners" + "https://api.github.com/users/octocat/followers" ] }, - "description": { - "type": [ - "string", - "null" - ], + "following_url": { + "type": "string", "examples": [ - "The description of the app." + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "external_url": { + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "https://example.com" + "https://api.github.com/users/octocat/subscriptions" ] }, - "html_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/apps/super-ci" + "https://api.github.com/users/octocat/orgs" ] }, - "created_at": { + "repos_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2017-07-08T16:18:44-04:00" + "https://api.github.com/users/octocat/repos" ] }, - "updated_at": { + "events_url": { "type": "string", - "format": "date-time", "examples": [ - "2017-07-08T16:18:44-04:00" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, + "type": { + "type": "string", "examples": [ - "label", - "deployment" + "User" ] }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", "examples": [ - 5 + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } ] }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } }, - "pin": { + "milestone": { "anyOf": [ { "type": "null" }, { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": "object", "properties": { - "pinned_at": { + "url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2011-04-14T16:00:49Z" + "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, - "pinned_by": { + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { "anyOf": [ { "type": "null" @@ -149746,2190 +152499,526 @@ ] } ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] } }, "required": [ - "pinned_at", - "pinned_by" + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" ] } ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - }, - "required": [ - "action", - "issue", - "comment" - ] - }, - { - "title": "ForkEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "forkee": { - "type": "object", - "properties": { - "id": { - "type": "integer" }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" + "locked": { + "type": "boolean" }, - "full_name": { - "type": "string" + "active_lock_reason": { + "type": [ + "string", + "null" + ] }, - "private": { - "type": "boolean" + "comments": { + "type": "integer" }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "pull_request": { "type": "object", "properties": { - "name": { + "merged_at": { "type": [ "string", "null" - ] + ], + "format": "date-time" }, - "email": { + "diff_url": { "type": [ "string", "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + ], + "format": "uri" }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" }, - "gravatar_id": { + "patch_url": { "type": [ "string", "null" ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] + "format": "uri" }, "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "type": [ + "string", + "null" + ], + "format": "uri" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "diff_url", "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", + "patch_url", "url" ] }, - "html_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { + "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, - "pushed_at": { - "type": [ - "string", - "null" - ], + "created_at": { + "type": "string", "format": "date-time" }, - "git_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "updated_at": { "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "forks_count": { - "type": "integer" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "archived": { - "type": "boolean" + "format": "date-time" }, - "disabled": { + "draft": { "type": "boolean" }, - "open_issues_count": { - "type": "integer" - }, - "license": { + "closed_by": { "anyOf": [ { "type": "null" }, { - "title": "License Simple", - "description": "License Simple", + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "key": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "mit" + "octocat" ] }, - "name": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", "examples": [ - "MIT License" + "MDQ6VXNlcjE=" ] }, - "url": { - "type": [ - "string", - "null" - ], + "avatar_url": { + "type": "string", "format": "uri", "examples": [ - "https://api.github.com/licenses/mit" + "https://github.com/images/error/octocat_happy.gif" ] }, - "spdx_id": { + "gravatar_id": { "type": [ "string", "null" ], "examples": [ - "MIT" + "41d064eb2195891e12d0413f63227ea7" ] }, - "node_id": { + "url": { "type": "string", + "format": "uri", "examples": [ - "MDc6TGljZW5zZW1pdA==" + "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } ] }, - "allow_forking": { - "type": "boolean" - }, - "is_template": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "visibility": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "public": { - "type": "boolean" - } - } - } - }, - "required": [ - "action", - "forkee" - ] - }, - { - "title": "GollumEvent", - "type": "object", - "properties": { - "pages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "page_name": { - "type": [ - "string", - "null" - ] - }, - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "action": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } - } - } - }, - "required": [ - "pages" - ] - }, - { - "title": "MemberEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "member": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "required": [ - "action", - "member" - ] - }, - { - "title": "PublicEvent", - "type": "object" - }, - { - "title": "PushEvent", - "type": "object", - "properties": { - "repository_id": { - "type": "integer" - }, - "push_id": { - "type": "integer" - }, - "ref": { - "type": "string" - }, - "head": { - "type": "string" - }, - "before": { - "type": "string" - } - }, - "required": [ - "repository_id", - "push_id", - "ref", - "head", - "before" - ] - }, - { - "title": "PullRequestEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "pull_request": { - "title": "Pull Request Minimal", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "name" - ] - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - }, - "base": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "name" - ] - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - } - }, - "required": [ - "id", - "number", - "url", - "head", - "base" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64", - "examples": [ - 208045946 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDU6TGFiZWwyMDgwNDU5NDY=" - ] - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/labels/bug" - ] - }, - "name": { - "description": "The name of the label.", - "type": "string", - "examples": [ - "bug" - ] - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ], - "examples": [ - "Something isn't working" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string", - "examples": [ - "FFFFFF" - ] - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "examples": [ - true - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64", - "examples": [ - 208045946 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDU6TGFiZWwyMDgwNDU5NDY=" - ] - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/labels/bug" - ] - }, - "name": { - "description": "The name of the label.", - "type": "string", - "examples": [ - "bug" - ] - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ], - "examples": [ - "Something isn't working" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string", - "examples": [ - "FFFFFF" - ] - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "examples": [ - true - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - }, - "required": [ - "action", - "number", - "pull_request" - ] - }, - { - "title": "PullRequestReviewCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "pull_request": { - "title": "Pull Request Minimal", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "number": { - "type": "integer" - }, - "url": { + "body_html": { "type": "string" }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "name" - ] - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - }, - "base": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "name" - ] - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - } - }, - "required": [ - "id", - "number", - "url", - "head", - "base" - ] - }, - "comment": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { + "body_text": { "type": "string" }, - "url": { + "timeline_url": { "type": "string", "format": "uri" }, - "pull_request_review_id": { - "type": [ - "integer", - "null" - ] - }, - "diff_hunk": { - "type": "string" - }, - "path": { - "type": "string" - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "original_position": { - "type": "integer" - }, - "subject_type": { - "type": [ - "string", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "title": "User", + "type": { + "title": "Issue Type", + "description": "The type of issue.", "type": [ "object", "null" ], "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, "id": { "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" + "description": "The unique identifier of the issue type." }, "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" + "description": "The node identifier of the issue type." }, - "starred_url": { + "name": { "type": "string", - "format": "uri-template" + "description": "The name of the issue type." }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." }, - "type": { - "type": "string", + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", "enum": [ - "Bot", - "User", - "Organization" + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null ] }, - "url": { + "created_at": { "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - } - }, - "body": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] + "description": "The time the issue type created.", + "format": "date-time" }, - "pull_request": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" }, - "self": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." } }, "required": [ - "self", - "html", - "pull_request" + "id", + "node_id", + "name", + "description" ] }, - "original_commit_id": { - "type": "string" - }, - "reactions": { - "title": "Reactions", + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] }, - "rocket": { - "type": "integer" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "total_count": { - "type": "integer" + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] }, - "url": { + "full_name": { "type": "string", - "format": "uri" - } - } - }, - "in_reply_to_id": { - "type": "integer" - } - }, - "required": [ - "url", - "pull_request_review_id", - "id", - "node_id", - "diff_hunk", - "path", - "position", - "original_position", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "_links", - "reactions" - ] - } - }, - "required": [ - "action", - "comment", - "pull_request" - ] - }, - { - "title": "PullRequestReviewEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "review": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" + "examples": [ + "octocat/Hello-World" + ] }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "license": { + "anyOf": [ + { + "type": "null" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" ] } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "type": "string" - }, - "commit_id": { - "type": "string" - }, - "submitted_at": { - "type": [ - "string", - "null" - ] - }, - "state": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" ] - } - }, - "required": [ - "html", - "pull_request" - ] - }, - "updated_at": { - "type": "string" - } - } - }, - "pull_request": { - "title": "Pull Request Minimal", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" }, - "sha": { - "type": "string" + "forks": { + "type": "integer" }, - "repo": { + "permissions": { "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64" + "admin": { + "type": "boolean" }, - "url": { - "type": "string" + "pull": { + "type": "boolean" }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "name" - ] - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - }, - "base": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" + "triage": { + "type": "boolean" }, - "url": { - "type": "string" + "push": { + "type": "boolean" }, - "name": { - "type": "string" + "maintain": { + "type": "boolean" } }, "required": [ - "id", - "url", - "name" + "admin", + "pull", + "push" ] - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - } - }, - "required": [ - "id", - "number", - "url", - "head", - "base" - ] - } - }, - "required": [ - "action", - "review", - "pull_request" - ] - }, - { - "title": "CommitCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "comment": { - "type": "object", - "properties": { - "html_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "body": { - "type": "string" - }, - "path": { - "type": [ - "string", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" }, - { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -152096,2405 +153185,6499 @@ "type", "url" ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] }, - "total_count": { - "type": "integer" + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] }, - "+1": { - "type": "integer" + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] }, - "-1": { - "type": "integer" + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] }, - "laugh": { - "type": "integer" + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] }, - "confused": { - "type": "integer" + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] }, - "heart": { - "type": "integer" + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] }, - "hooray": { - "type": "integer" + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] }, - "eyes": { - "type": "integer" + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - } - } - }, - "required": [ - "action", - "comment" - ] - }, - { - "title": "ReleaseEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "release": { - "allOf": [ - { - "title": "Release", - "description": "A release.", - "type": "object", - "properties": { - "url": { + "contents_url": { "type": "string", - "format": "uri" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] }, - "html_url": { + "contributors_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] }, - "assets_url": { + "deployments_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] }, - "upload_url": { - "type": "string" + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] }, - "id": { - "type": "integer" + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] }, - "node_id": { - "type": "string" + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] }, - "tag_name": { - "description": "The name of the tag.", + "git_tags_url": { "type": "string", "examples": [ - "v1.0.0" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", + "git_url": { "type": "string", "examples": [ - "master" + "git:github.com/octocat/Hello-World.git" ] }, - "name": { - "type": [ - "string", - "null" + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, - "body": { - "type": [ - "string", - "null" + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, - "draft": { - "description": "true to create a draft (unpublished) release, false to create a published one.", - "type": "boolean", + "issues_url": { + "type": "string", "examples": [ - false + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, - "prerelease": { - "description": "Whether to identify the release as a prerelease or a full release.", - "type": "boolean", + "keys_url": { + "type": "string", "examples": [ - false + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean", + "labels_url": { + "type": "string", "examples": [ - false + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, - "created_at": { + "languages_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] }, - "author": { - "title": "Simple User", - "description": "A GitHub user.", + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ], + "examples": [ + "all" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { "type": "object", + "description": "The status of the code search index for this repository", "properties": { - "name": { - "type": [ - "string", - "null" - ] + "lexical_search_ok": { + "type": "boolean" }, - "email": { - "type": [ - "string", - "null" + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": { + "properties": { + "use_squash_pr_title_as_default": null + } + }, + "version": "2026-03-10" + }, + { + "changeset": "deprecate_beta_media_type", + "patch": { + "properties": { + "master_branch": null + } + }, + "version": "2026-03-10" + }, + { + "changeset": "remove_has_downloads", + "patch": { + "properties": { + "has_downloads": null + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "version": "2026-03-10" + } + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 ] }, - "login": { + "slug": { + "description": "The slug name of the GitHub app", "type": "string", "examples": [ - "octocat" + "probot-owners" ] }, - "id": { - "type": "integer", - "format": "int64", + "node_id": { + "type": "string", "examples": [ - 1 + "MDExOkludGVncmF0aW9uMQ==" ] }, - "node_id": { + "client_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "\"Iv1.25b5d1e65ffc4022\"" ] }, - "avatar_url": { + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "Probot Owners" ] }, - "gravatar_id": { + "description": { "type": [ "string", "null" ], "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "The description of the app." ] }, - "url": { + "external_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "https://github.com/apps/super-ci" ] }, - "followers_url": { + "created_at": { "type": "string", - "format": "uri", + "format": "date-time", "examples": [ - "https://api.github.com/users/octocat/followers" + "2017-07-08T16:18:44-04:00" ] }, - "following_url": { + "updated_at": { "type": "string", + "format": "date-time", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "2017-07-08T16:18:44-04:00" ] }, - "gists_url": { - "type": "string", + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "label", + "deployment" ] }, - "starred_url": { - "type": "string", + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + 5 ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "parent_issue_url": { + "description": "URL to get the parent issue of this issue, if it is a sub-issue", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "pinned_comment": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + 42 ] }, - "organizations_url": { + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://api.github.com/repositories/42/issues/comments/1" ] }, - "repos_url": { + "body": { + "description": "Contents of the issue comment", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "What version of Safari were you using when you observed this bug?" ] }, - "events_url": { + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "received_events_url": { + "created_at": { "type": "string", - "format": "uri", + "format": "date-time", "examples": [ - "https://api.github.com/users/octocat/received_events" + "2011-04-14T16:00:49Z" ] }, - "type": { + "updated_at": { "type": "string", + "format": "date-time", "examples": [ - "User" + "2011-04-14T16:00:49Z" ] }, - "site_admin": { - "type": "boolean" + "issue_url": { + "type": "string", + "format": "uri" }, - "starred_at": { + "author_association": { + "title": "author_association", "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], "examples": [ - "\"2020-07-09T00:17:55Z\"" + "OWNER" ] }, - "user_view_type": { - "type": "string", - "examples": [ - "public" + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "pinned_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "pinned_at", + "pinned_by" + ] + } ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" ] + } + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" }, - "assets": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { "type": "string", - "enum": [ - "uploaded", - "open" + "examples": [ + "Sample text" ] }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" + { + "type": "number", + "examples": [ + 42.5 ] }, - "download_count": { - "type": "integer" + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] }, - "created_at": { + "name": { + "description": "The name of the option", "type": "string", - "format": "date-time" + "examples": [ + "High" + ] }, - "updated_at": { + "color": { + "description": "The color of the option", "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "examples": [ + "red" ] } }, "required": [ "id", "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" + "color" ] } }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "mentions_count": { - "type": "integer" + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "created_at", + "updated_at" + ], + "x-github-breaking-changes": [ + { + "changeset": "deprecate_beta_media_type", + "patch": { + "properties": { + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "nullable": false + }, + "diff_url": { + "nullable": false + }, + "html_url": { + "nullable": false + }, + "patch_url": { + "nullable": false + }, + "url": { + "nullable": false + } + } + } + } + }, + "version": "2026-03-10" + }, + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": { + "properties": { + "assignee": null }, - "discussion_url": { - "description": "The URL of the release discussion.", - "type": "string", - "format": "uri" + "required": [ + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "created_at", + "updated_at" + ] + }, + "version": "2026-03-10" + } + ] + }, + "comment": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/comments/1" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string", + "examples": [ + "What version of Safari were you using when you observed this bug?" + ] + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" }, - "reactions": { - "title": "Reaction Rollup", + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "total_count": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "+1": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "-1": { - "type": "integer" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "laugh": { - "type": "integer" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "confused": { - "type": "integer" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "heart": { - "type": "integer" + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "hooray": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, - "eyes": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "rocket": { - "type": "integer" + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } }, "required": [ - "assets_url", - "upload_url", - "tarball_url", - "zipball_url", - "created_at", - "published_at", - "draft", - "id", - "node_id", - "author", - "html_url", - "name", - "prerelease", - "tag_name", - "target_commitish", - "assets", - "url" + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] }, - { + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "pinned_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "pinned_at", + "pinned_by" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ] + } + }, + "required": [ + "action", + "issue", + "comment" + ] + }, + { + "title": "ForkEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "forkee": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "private": { + "type": "boolean" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "is_short_description_html_truncated": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { "type": "boolean" }, - "short_description_html": { - "type": "string" + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "html_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "git_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "has_pull_requests": { + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "forks_count": { + "type": "integer" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "open_issues_count": { + "type": "integer" + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] } + ] + }, + "allow_forking": { + "type": "boolean" + }, + "is_template": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" } + }, + "visibility": { + "type": "string" + }, + "forks": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "public": { + "type": "boolean" } - ] + } } }, "required": [ "action", - "release" + "forkee" ] }, { - "title": "WatchEvent", + "title": "GollumEvent", "type": "object", "properties": { - "action": { - "type": "string" + "pages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "page_name": { + "type": [ + "string", + "null" + ] + }, + "title": { + "type": [ + "string", + "null" + ] + }, + "summary": { + "type": [ + "string", + "null" + ] + }, + "action": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "html_url": { + "type": "string" + } + } + } } }, "required": [ - "action" - ] - } - ] - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "type", - "actor", - "repo", - "payload", - "public", - "created_at" - ] - } - }, - "examples": { - "200-response": { - "value": [ - { - "id": "22237752260", - "type": "WatchEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octo-org/octo-repo", - "url": "https://api.github.com/repos/octo-org/octo-repo" - }, - "payload": { - "action": "started" - }, - "public": true, - "created_at": "2022-06-08T23:29:25Z", - "org": { - "id": 9919, - "login": "octo-org", - "gravatar_id": "", - "url": "https://api.github.com/orgs/octo-org", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?" - } - }, - { - "id": "22249084964", - "type": "PushEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octo-org/octo-repo", - "url": "https://api.github.com/repos/octo-org/octo-repo" - }, - "payload": { - "repository_id": 1296269, - "push_id": 10115855396, - "ref": "refs/heads/master", - "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "before": "883efe034920928c47fe18598c01249d1a9fdabd" - }, - "public": true, - "created_at": "2022-06-09T12:47:28Z", - "org": { - "id": 9919, - "login": "octo-org", - "gravatar_id": "", - "url": "https://api.github.com/orgs/octo-org", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?" - } - } - ] - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "activity", - "subcategory": "events" - } - } - }, - "/orgs/{org}/failed_invitations": { - "get": { - "summary": "List failed organization invitations", - "description": "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.", - "tags": [ - "orgs" - ], - "operationId": "orgs/list-failed-invitations", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#list-failed-organization-invitations" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Organization Invitation", - "description": "Organization Invitation", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "role": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "failed_at": { - "type": [ - "string", - "null" - ] - }, - "failed_reason": { - "type": [ - "string", - "null" - ] - }, - "inviter": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "team_count": { - "type": "integer" - }, - "node_id": { - "type": "string", - "examples": [ - "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" - ] - }, - "invitation_teams_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/organizations/16/invitations/1/teams\"" - ] - }, - "invitation_source": { - "type": "string", - "examples": [ - "\"member\"" - ] - } - }, - "required": [ - "id", - "login", - "email", - "role", - "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "login": "monalisa", - "node_id": "MDQ6VXNlcjE=", - "email": "octocat@github.com", - "role": "direct_member", - "created_at": "2016-11-30T06:46:10-08:00", - "failed_at": "", - "failed_reason": "", - "inviter": { - "login": "other_user", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", - "type": "User", - "site_admin": false - }, - "team_count": 2, - "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", - "invitation_source": "member" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "members" - } - } - }, - "/orgs/{org}/hooks": { - "get": { - "summary": "List organization webhooks", - "description": "List webhooks for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", - "tags": [ - "orgs" - ], - "operationId": "orgs/list-webhooks", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Org Hook", - "description": "Org Hook", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1" - ] - }, - "ping_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/pings" - ] - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/deliveries" - ] - }, - "name": { - "type": "string", - "examples": [ - "web" - ] - }, - "events": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "push", - "pull_request" - ] - }, - "active": { - "type": "boolean", - "examples": [ - true - ] - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "examples": [ - "\"http://example.com/2\"" + "pages" ] }, - "insecure_ssl": { - "type": "string", - "examples": [ - "\"0\"" + { + "title": "MemberEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "member": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "member" ] }, - "content_type": { - "type": "string", - "examples": [ - "\"form\"" - ] + { + "title": "PublicEvent", + "type": "object" }, - "secret": { - "type": "string", - "examples": [ - "\"********\"" - ] - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T20:39:23Z" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T17:26:27Z" - ] - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "url": "https://api.github.com/orgs/octocat/hooks/1", - "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", - "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", - "name": "web", - "events": [ - "push", - "pull_request" - ], - "active": true, - "config": { - "url": "http://example.com", - "content_type": "json" - }, - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "type": "Organization" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" - } - }, - "post": { - "summary": "Create an organization webhook", - "description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or\nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", - "tags": [ - "orgs" - ], - "operationId": "orgs/create-webhook", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Must be passed as \"web\"." - }, - "config": { - "type": "object", - "description": "Key/value pairs to provide settings for this webhook.", - "properties": { - "url": { - "type": "string", - "description": "The URL to which the payloads will be delivered.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "insecure_ssl": { - "oneOf": [ { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" + "title": "PushEvent", + "type": "object", + "properties": { + "repository_id": { + "type": "integer" + }, + "push_id": { + "type": "integer" + }, + "ref": { + "type": "string" + }, + "head": { + "type": "string" + }, + "before": { + "type": "string" + } + }, + "required": [ + "repository_id", + "push_id", + "ref", + "head", + "before" ] }, { - "type": "number" - } - ] - }, - "username": { - "type": "string", - "examples": [ - "\"kdaigle\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"password\"" - ] - } - }, - "required": [ - "url" - ] - }, - "events": { - "type": "array", - "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.", - "default": [ - "push" - ], - "items": { - "type": "string" - } - }, - "active": { - "type": "boolean", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "default": true - } - }, - "required": [ - "name", - "config" - ] - }, - "examples": { - "default": { - "value": { - "name": "web", - "active": true, - "events": [ - "push", - "pull_request" - ], - "config": { - "url": "http://example.com/webhook", - "content_type": "json" - } - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Org Hook", - "description": "Org Hook", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1" - ] - }, - "ping_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/pings" - ] - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/deliveries" - ] - }, - "name": { - "type": "string", - "examples": [ - "web" - ] - }, - "events": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "push", - "pull_request" - ] - }, - "active": { - "type": "boolean", - "examples": [ - true - ] - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "examples": [ - "\"http://example.com/2\"" - ] - }, - "insecure_ssl": { - "type": "string", - "examples": [ - "\"0\"" - ] - }, - "content_type": { - "type": "string", - "examples": [ - "\"form\"" - ] - }, - "secret": { - "type": "string", - "examples": [ - "\"********\"" - ] - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T20:39:23Z" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T17:26:27Z" - ] - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "url": "https://api.github.com/orgs/octocat/hooks/1", - "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", - "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", - "name": "web", - "events": [ - "push", - "pull_request" - ], - "active": true, - "config": { - "url": "http://example.com", - "content_type": "json" - }, - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "type": "Organization" - } - } - } - } - }, - "headers": { - "Location": { - "example": "https://api.github.com/orgs/octocat/hooks/1", - "schema": { - "type": "string" - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" + "title": "PullRequestEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "pull_request": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" ] }, - { - "type": [ - "integer", - "null" + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - { - "type": [ - "array", - "null" - ], + "assignees": { + "type": "array", "items": { - "type": "string" + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "label": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "examples": [ + 208045946 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDU6TGFiZWwyMDgwNDU5NDY=" + ] + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/labels/bug" + ] + }, + "name": { + "description": "The name of the label.", + "type": "string", + "examples": [ + "bug" + ] + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": [ + "string", + "null" + ], + "examples": [ + "Something isn't working" + ] + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string", + "examples": [ + "FFFFFF" + ] + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "examples": [ + 208045946 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDU6TGFiZWwyMDgwNDU5NDY=" + ] + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/labels/bug" + ] + }, + "name": { + "description": "The name of the label.", + "type": "string", + "examples": [ + "bug" + ] + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": [ + "string", + "null" + ], + "examples": [ + "Something isn't working" + ] + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string", + "examples": [ + "FFFFFF" + ] + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" - } - } - }, - "/orgs/{org}/hooks/{hook_id}": { - "get": { - "summary": "Get an organization webhook", - "description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", - "tags": [ - "orgs" - ], - "operationId": "orgs/get-webhook", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Org Hook", - "description": "Org Hook", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1" - ] - }, - "ping_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/pings" - ] - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/deliveries" - ] - }, - "name": { - "type": "string", - "examples": [ - "web" - ] - }, - "events": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "push", - "pull_request" - ] - }, - "active": { - "type": "boolean", - "examples": [ - true - ] - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "examples": [ - "\"http://example.com/2\"" - ] - }, - "insecure_ssl": { - "type": "string", - "examples": [ - "\"0\"" - ] - }, - "content_type": { - "type": "string", - "examples": [ - "\"form\"" - ] - }, - "secret": { - "type": "string", - "examples": [ - "\"********\"" - ] - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T20:39:23Z" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T17:26:27Z" - ] - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "url": "https://api.github.com/orgs/octocat/hooks/1", - "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", - "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", - "name": "web", - "events": [ - "push", - "pull_request" - ], - "active": true, - "config": { - "url": "http://example.com", - "content_type": "json" - }, - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "type": "Organization" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" - } - }, - "patch": { - "summary": "Update an organization webhook", - "description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\".\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", - "tags": [ - "orgs" - ], - "operationId": "orgs/update-webhook", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "config": { - "type": "object", - "description": "Key/value pairs to provide settings for this webhook.", - "properties": { - "url": { - "type": "string", - "description": "The URL to which the payloads will be delivered.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" + }, + "required": [ + "action", + "number", + "pull_request" ] }, { - "type": "number" - } - ] - } - }, - "required": [ - "url" - ] - }, - "events": { - "type": "array", - "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.", - "default": [ - "push" - ], - "items": { - "type": "string" - } - }, - "active": { - "type": "boolean", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "default": true - }, - "name": { - "type": "string", - "examples": [ - "\"web\"" - ] - } - } - }, - "examples": { - "default": { - "value": { - "active": true, - "events": [ - "pull_request" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Org Hook", - "description": "Org Hook", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1" - ] - }, - "ping_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/pings" - ] - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/deliveries" - ] - }, - "name": { - "type": "string", - "examples": [ - "web" - ] - }, - "events": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "push", - "pull_request" - ] - }, - "active": { - "type": "boolean", - "examples": [ - true - ] - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "examples": [ - "\"http://example.com/2\"" - ] - }, - "insecure_ssl": { - "type": "string", - "examples": [ - "\"0\"" - ] - }, - "content_type": { - "type": "string", - "examples": [ - "\"form\"" - ] - }, - "secret": { - "type": "string", - "examples": [ - "\"********\"" - ] - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T20:39:23Z" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T17:26:27Z" - ] - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "url": "https://api.github.com/orgs/octocat/hooks/1", - "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", - "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", - "name": "web", - "events": [ - "pull_request" - ], - "active": true, - "config": { - "url": "http://example.com", - "content_type": "json" - }, - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "type": "Organization" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" + "title": "PullRequestReviewCommentEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "pull_request": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" ] }, - { - "type": [ - "integer", - "null" + "comment": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "pull_request_review_id": { + "type": [ + "integer", + "null" + ] + }, + "diff_hunk": { + "type": "string" + }, + "path": { + "type": "string" + }, + "position": { + "type": [ + "integer", + "null" + ] + }, + "original_position": { + "type": "integer" + }, + "subject_type": { + "type": [ + "string", + "null" + ] + }, + "commit_id": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "body": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "pull_request_url": { + "type": "string", + "format": "uri" + }, + "_links": { + "type": "object", + "properties": { + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "pull_request": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "pull_request" + ] + }, + "original_commit_id": { + "type": "string" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "in_reply_to_id": { + "type": "integer" + } + }, + "required": [ + "url", + "pull_request_review_id", + "id", + "node_id", + "diff_hunk", + "path", + "position", + "original_position", + "commit_id", + "original_commit_id", + "user", + "body", + "created_at", + "updated_at", + "html_url", + "pull_request_url", + "_links", + "reactions" ] + } + }, + "required": [ + "action", + "comment", + "pull_request" + ] + }, + { + "title": "PullRequestReviewEvent", + "type": "object", + "properties": { + "action": { + "type": "string" }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" + "review": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body": { + "type": "string" + }, + "commit_id": { + "type": "string" + }, + "submitted_at": { + "type": [ + "string", + "null" + ] + }, + "state": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "pull_request_url": { + "type": "string", + "format": "uri" + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "html", + "pull_request" + ] + }, + "updated_at": { + "type": "string" + } + } + }, + "pull_request": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "required": [ + "action", + "review", + "pull_request" + ] + }, + { + "title": "CommitCommentEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "comment": { + "type": "object", + "properties": { + "html_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "body": { + "type": "string" + }, + "path": { + "type": [ + "string", + "null" + ] + }, + "position": { + "type": [ + "integer", + "null" + ] + }, + "line": { + "type": [ + "integer", + "null" + ] + }, + "commit_id": { + "type": "string" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } } } + }, + "required": [ + "action", + "comment" + ] + }, + { + "title": "ReleaseEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "release": { + "allOf": [ + { + "title": "Release", + "description": "A release.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "assets_url": { + "type": "string", + "format": "uri" + }, + "upload_url": { + "type": "string" + }, + "tarball_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "zipball_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "tag_name": { + "description": "The name of the tag.", + "type": "string", + "examples": [ + "v1.0.0" + ] + }, + "target_commitish": { + "description": "Specifies the commitish value that determines where the Git tag is created from.", + "type": "string", + "examples": [ + "master" + ] + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "draft": { + "description": "true to create a draft (unpublished) release, false to create a published one.", + "type": "boolean", + "examples": [ + false + ] + }, + "prerelease": { + "description": "Whether to identify the release as a prerelease or a full release.", + "type": "boolean", + "examples": [ + false + ] + }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "published_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "author": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "assets": { + "type": "array", + "items": { + "title": "Release Asset", + "description": "Data related to a release.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "browser_download_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The file name of the asset.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "label": { + "type": [ + "string", + "null" + ] + }, + "state": { + "description": "State of the release asset.", + "type": "string", + "enum": [ + "uploaded", + "open" + ] + }, + "content_type": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "digest": { + "type": [ + "string", + "null" + ] + }, + "download_count": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "uploader": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "id", + "name", + "content_type", + "size", + "digest", + "state", + "url", + "node_id", + "download_count", + "label", + "uploader", + "browser_download_url", + "created_at", + "updated_at" + ] + } + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "mentions_count": { + "type": "integer" + }, + "discussion_url": { + "description": "The URL of the release discussion.", + "type": "string", + "format": "uri" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "assets_url", + "upload_url", + "tarball_url", + "zipball_url", + "created_at", + "published_at", + "draft", + "id", + "node_id", + "author", + "html_url", + "name", + "prerelease", + "tag_name", + "target_commitish", + "assets", + "url" + ] + }, + { + "type": "object", + "properties": { + "is_short_description_html_truncated": { + "type": "boolean" + }, + "short_description_html": { + "type": "string" + } + } + } + ] + } + }, + "required": [ + "action", + "release" + ] + }, + { + "title": "WatchEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + } + }, + "required": [ + "action" ] } - } + ] + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } + "required": [ + "id", + "type", + "actor", + "repo", + "payload", + "public", + "created_at" + ] + } + }, + "examples": { + "200-response": { + "value": [ + { + "id": "22237752260", + "type": "WatchEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octo-org/octo-repo", + "url": "https://api.github.com/repos/octo-org/octo-repo" + }, + "payload": { + "action": "started" + }, + "public": true, + "created_at": "2022-06-08T23:29:25Z", + "org": { + "id": 9919, + "login": "octo-org", + "gravatar_id": "", + "url": "https://api.github.com/orgs/octo-org", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?" + } + }, + { + "id": "22249084964", + "type": "PushEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octo-org/octo-repo", + "url": "https://api.github.com/repos/octo-org/octo-repo" + }, + "payload": { + "repository_id": 1296269, + "push_id": 10115855396, + "ref": "refs/heads/master", + "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", + "before": "883efe034920928c47fe18598c01249d1a9fdabd" + }, + "public": true, + "created_at": "2022-06-09T12:47:28Z", + "org": { + "id": 9919, + "login": "octo-org", + "gravatar_id": "", + "url": "https://api.github.com/orgs/octo-org", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?" + } + } + ] } } } @@ -154504,20 +159687,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" + "category": "activity", + "subcategory": "events" } - }, - "delete": { - "summary": "Delete an organization webhook", - "description": "Delete a webhook for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + } + }, + "/orgs/{org}/failed_invitations": { + "get": { + "summary": "List failed organization invitations", + "description": "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.", "tags": [ "orgs" ], - "operationId": "orgs/delete-webhook", + "operationId": "orgs/list-failed-invitations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook" + "url": "https://docs.github.com/rest/orgs/members#list-failed-organization-invitations" }, "parameters": [ { @@ -154530,20 +159715,1603 @@ } }, { - "name": "hook_id", - "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", - "in": "path", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", "schema": { - "type": "integer" + "type": "integer", + "default": 30 } - } - ], - "responses": { - "204": { - "description": "Response" }, - "404": { + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Invitation", + "description": "Organization Invitation", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": [ + "string", + "null" + ] + }, + "failed_reason": { + "type": [ + "string", + "null" + ] + }, + "inviter": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "team_count": { + "type": "integer" + }, + "node_id": { + "type": "string", + "examples": [ + "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + ] + }, + "invitation_teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/organizations/16/invitations/1/teams\"" + ] + }, + "invitation_source": { + "type": "string", + "examples": [ + "\"member\"" + ] + } + }, + "required": [ + "id", + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_teams_url", + "node_id" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "failed_at": "", + "failed_reason": "", + "inviter": { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false + }, + "team_count": 2, + "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", + "invitation_source": "member" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + } + }, + "/orgs/{org}/hooks": { + "get": { + "summary": "List organization webhooks", + "description": "List webhooks for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-webhooks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Org Hook", + "description": "Org Hook", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1" + ] + }, + "ping_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/pings" + ] + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/deliveries" + ] + }, + "name": { + "type": "string", + "examples": [ + "web" + ] + }, + "events": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "push", + "pull_request" + ] + }, + "active": { + "type": "boolean", + "examples": [ + true + ] + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string", + "examples": [ + "\"http://example.com/2\"" + ] + }, + "insecure_ssl": { + "type": "string", + "examples": [ + "\"0\"" + ] + }, + "content_type": { + "type": "string", + "examples": [ + "\"form\"" + ] + }, + "secret": { + "type": "string", + "examples": [ + "\"********\"" + ] + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T20:39:23Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T17:26:27Z" + ] + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", + "name": "web", + "events": [ + "push", + "pull_request" + ], + "active": true, + "config": { + "url": "http://example.com", + "content_type": "json" + }, + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "webhooks" + } + }, + "post": { + "summary": "Create an organization webhook", + "description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or\nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Must be passed as \"web\"." + }, + "config": { + "type": "object", + "description": "Key/value pairs to provide settings for this webhook.", + "properties": { + "url": { + "type": "string", + "description": "The URL to which the payloads will be delivered.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, + "insecure_ssl": { + "oneOf": [ + { + "type": "string", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "examples": [ + "\"0\"" + ] + }, + { + "type": "number" + } + ] + }, + "username": { + "type": "string", + "examples": [ + "\"kdaigle\"" + ] + }, + "password": { + "type": "string", + "examples": [ + "\"password\"" + ] + } + }, + "required": [ + "url" + ] + }, + "events": { + "type": "array", + "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.", + "default": [ + "push" + ], + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "default": true + } + }, + "required": [ + "name", + "config" + ] + }, + "examples": { + "default": { + "value": { + "name": "web", + "active": true, + "events": [ + "push", + "pull_request" + ], + "config": { + "url": "http://example.com/webhook", + "content_type": "json" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Org Hook", + "description": "Org Hook", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1" + ] + }, + "ping_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/pings" + ] + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/deliveries" + ] + }, + "name": { + "type": "string", + "examples": [ + "web" + ] + }, + "events": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "push", + "pull_request" + ] + }, + "active": { + "type": "boolean", + "examples": [ + true + ] + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string", + "examples": [ + "\"http://example.com/2\"" + ] + }, + "insecure_ssl": { + "type": "string", + "examples": [ + "\"0\"" + ] + }, + "content_type": { + "type": "string", + "examples": [ + "\"form\"" + ] + }, + "secret": { + "type": "string", + "examples": [ + "\"********\"" + ] + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T20:39:23Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T17:26:27Z" + ] + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", + "name": "web", + "events": [ + "push", + "pull_request" + ], + "active": true, + "config": { + "url": "http://example.com", + "content_type": "json" + }, + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/orgs/octocat/hooks/1", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "webhooks" + } + } + }, + "/orgs/{org}/hooks/{hook_id}": { + "get": { + "summary": "Get an organization webhook", + "description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "hook_id", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Org Hook", + "description": "Org Hook", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1" + ] + }, + "ping_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/pings" + ] + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/deliveries" + ] + }, + "name": { + "type": "string", + "examples": [ + "web" + ] + }, + "events": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "push", + "pull_request" + ] + }, + "active": { + "type": "boolean", + "examples": [ + true + ] + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string", + "examples": [ + "\"http://example.com/2\"" + ] + }, + "insecure_ssl": { + "type": "string", + "examples": [ + "\"0\"" + ] + }, + "content_type": { + "type": "string", + "examples": [ + "\"form\"" + ] + }, + "secret": { + "type": "string", + "examples": [ + "\"********\"" + ] + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T20:39:23Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T17:26:27Z" + ] + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", + "name": "web", + "events": [ + "push", + "pull_request" + ], + "active": true, + "config": { + "url": "http://example.com", + "content_type": "json" + }, + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "webhooks" + } + }, + "patch": { + "summary": "Update an organization webhook", + "description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\".\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "hook_id", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "config": { + "type": "object", + "description": "Key/value pairs to provide settings for this webhook.", + "properties": { + "url": { + "type": "string", + "description": "The URL to which the payloads will be delivered.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, + "insecure_ssl": { + "oneOf": [ + { + "type": "string", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "examples": [ + "\"0\"" + ] + }, + { + "type": "number" + } + ] + } + }, + "required": [ + "url" + ] + }, + "events": { + "type": "array", + "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.", + "default": [ + "push" + ], + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "default": true + }, + "name": { + "type": "string", + "examples": [ + "\"web\"" + ] + } + } + }, + "examples": { + "default": { + "value": { + "active": true, + "events": [ + "pull_request" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Org Hook", + "description": "Org Hook", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1" + ] + }, + "ping_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/pings" + ] + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/deliveries" + ] + }, + "name": { + "type": "string", + "examples": [ + "web" + ] + }, + "events": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "push", + "pull_request" + ] + }, + "active": { + "type": "boolean", + "examples": [ + true + ] + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string", + "examples": [ + "\"http://example.com/2\"" + ] + }, + "insecure_ssl": { + "type": "string", + "examples": [ + "\"0\"" + ] + }, + "content_type": { + "type": "string", + "examples": [ + "\"form\"" + ] + }, + "secret": { + "type": "string", + "examples": [ + "\"********\"" + ] + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T20:39:23Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T17:26:27Z" + ] + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", + "name": "web", + "events": [ + "pull_request" + ], + "active": true, + "config": { + "url": "http://example.com", + "content_type": "json" + }, + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "webhooks" + } + }, + "delete": { + "summary": "Delete an organization webhook", + "description": "Delete a webhook for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "hook_id", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { "description": "Resource not found", "content": { "application/json": { @@ -157798,7 +164566,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -158953,7 +165721,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -276444,6 +283212,14 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether the repository has opted in to the immutable OIDC subject claim format. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim. If not set at the repository level, falls back to the organization-level setting.", + "type": "boolean" + }, + "sub_claim_prefix": { + "description": "The current `sub` claim prefix for this repository.", + "type": "string" } }, "required": [ @@ -276619,6 +283395,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for this repository. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim.", + "type": "boolean" } } }, @@ -297934,6 +304714,11 @@ { "op": "remove", "path": "/requestBody/content/application~1json/schema/properties/return_run_details" + }, + { + "op": "replace", + "path": "/responses/200/description", + "value": "Response including the workflow run ID and URLs." } ], "version": "2026-03-10" @@ -435847,7 +442632,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -642628,6 +649413,18 @@ "string", "null" ] + }, + "validity": { + "type": [ + "string", + "null" + ], + "enum": [ + "active", + "inactive", + null + ], + "description": "Sets the validity of the secret scanning alert. Can be `active`, `inactive`, or `null` to clear the override." } }, "anyOf": [ @@ -644224,7 +651021,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" + "description": "State does not match the resolution or resolution comment, assignee does not have write access to the repository, or the requested validity change could not be applied to this alert" }, "503": { "description": "Service unavailable", @@ -723628,7 +730425,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -759699,4536 +766496,11663 @@ "updated_at" ] }, - "version": "2026-03-10" - } - ] - } - }, - "required": [ - "starred_at", - "repo" - ] - } - }, - "examples": { - "alternative-response-with-star-creation-timestamps": { - "summary": "Alternative response with star creation timestamps", - "value": [ - { - "starred_at": "2011-01-16T19:06:43Z", - "repo": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "template_repository": null, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "activity", - "subcategory": "starring" - } - } - }, - "/user/starred/{owner}/{repo}": { - "get": { - "summary": "Check if a repository is starred by the authenticated user", - "description": "Whether the authenticated user has starred the repository.", - "tags": [ - "activity" - ], - "operationId": "activity/check-repo-is-starred-by-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response if this repository is starred by you" - }, - "404": { - "description": "Not Found if this repository is not starred by you", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "activity", - "subcategory": "starring" - } - }, - "put": { - "summary": "Star a repository for the authenticated user", - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", - "tags": [ - "activity" - ], - "operationId": "activity/star-repo-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "activity", - "subcategory": "starring" - } - }, - "delete": { - "summary": "Unstar a repository for the authenticated user", - "description": "Unstar a repository that the authenticated user has previously starred.", - "tags": [ - "activity" - ], - "operationId": "activity/unstar-repo-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "activity", - "subcategory": "starring" - } - } - }, - "/user/subscriptions": { - "get": { - "summary": "List repositories watched by the authenticated user", - "description": "Lists repositories the authenticated user is watching.", - "tags": [ - "activity" - ], - "operationId": "activity/list-watched-repos-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/activity/watching#list-repositories-watched-by-the-authenticated-user" - }, - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_bypass": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" + "version": "2026-03-10" + } + ] + } + }, + "required": [ + "starred_at", + "repo" + ] + } + }, + "examples": { + "alternative-response-with-star-creation-timestamps": { + "summary": "Alternative response with star creation timestamps", + "value": [ + { + "starred_at": "2011-01-16T19:06:43Z", + "repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "starring" + } + } + }, + "/user/starred/{owner}/{repo}": { + "get": { + "summary": "Check if a repository is starred by the authenticated user", + "description": "Whether the authenticated user has starred the repository.", + "tags": [ + "activity" + ], + "operationId": "activity/check-repo-is-starred-by-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response if this repository is starred by you" + }, + "404": { + "description": "Not Found if this repository is not starred by you", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "starring" + } + }, + "put": { + "summary": "Star a repository for the authenticated user", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "tags": [ + "activity" + ], + "operationId": "activity/star-repo-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "starring" + } + }, + "delete": { + "summary": "Unstar a repository for the authenticated user", + "description": "Unstar a repository that the authenticated user has previously starred.", + "tags": [ + "activity" + ], + "operationId": "activity/unstar-repo-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "starring" + } + } + }, + "/user/subscriptions": { + "get": { + "summary": "List repositories watched by the authenticated user", + "description": "Lists repositories the authenticated user is watching.", + "tags": [ + "activity" + ], + "operationId": "activity/list-watched-repos-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/watching#list-repositories-watched-by-the-authenticated-user" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "has_pull_requests": { + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + }, + "mode": { + "type": "string", + "description": "The bypass mode for the reviewer", + "enum": [ + "ALWAYS", + "EXEMPT" + ], + "default": "ALWAYS" + } + } + } + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": { + "properties": { + "has_downloads": null + } + }, + "version": "2026-03-10" + } + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + }, + "secret_scanning_delegated_alert_dismissal": { + "status": "disabled" + } + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "watching" + } + } + }, + "/user/teams": { + "get": { + "summary": "List teams for the authenticated user", + "description": "List all of the teams across all of the organizations to which the authenticated\nuser belongs.\n\nOAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint.\n\nWhen using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.", + "tags": [ + "teams" + ], + "operationId": "teams/list-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#list-teams-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Developers" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "push" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ] + } + ] + }, + "members_count": { + "type": "integer", + "examples": [ + 3 + ] + }, + "repos_count": { + "type": "integer", + "examples": [ + 10 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-14T16:53:42Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-08-17T12:37:15Z" + ] + }, + "organization": { + "title": "Team Organization", + "description": "Team Organization", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "examples": [ + "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type", + "created_at", + "updated_at", + "members_count", + "repos_count", + "organization" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "teams", + "subcategory": "teams" + } + } + }, + "/user/{account_id}": { + "get": { + "summary": "Get a user using their ID", + "description": "Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).", + "tags": [ + "users" + ], + "operationId": "users/get-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/users#get-a-user-using-their-id" + }, + "parameters": [ + { + "name": "account_id", + "description": "account_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "user_view_type": { + "type": "string" + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "user_view_type": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + } + ] + }, + "examples": { + "default-response": { + "summary": "Default response", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "response-with-git-hub-plan-information": { + "summary": "Response with GitHub plan information", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "plan": { + "name": "pro", + "space": 976562499, + "collaborators": 0, + "private_repos": 9999 + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" + } + } + }, + "/user/{user_id}/projectsV2/{project_number}/drafts": { + "post": { + "summary": "Create draft item for user owned project", + "description": "Create draft issue item for the specified user owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/create-draft-item-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project" + }, + "parameters": [ + { + "name": "user_id", + "description": "The unique identifier of the user.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_number", + "description": "The project's number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "description": "Details of the draft item to create in the project.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the draft issue item to create in the project." + }, + "body": { + "type": "string", + "description": "The body content of the draft issue item to create in the project." + } + }, + "required": [ + "title" + ] + }, + "examples": { + "title": { + "summary": "Example with Sample Draft Issue Title", + "value": { + "title": "Sample Draft Issue Title" + } + }, + "body": { + "summary": "Example with Sample Draft Issue Title and Body", + "value": { + "title": "Sample Draft Issue Title", + "body": "This is the body content of the draft issue." + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project item." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project item." + }, + "content": { + "oneOf": [ + { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ], + "examples": [ + "all" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": { + "properties": { + "use_squash_pr_title_as_default": null + } + }, + "version": "2026-03-10" + }, + { + "changeset": "deprecate_beta_media_type", + "patch": { + "properties": { + "master_branch": null + } + }, + "version": "2026-03-10" + }, + { + "changeset": "remove_has_downloads", + "patch": { + "properties": { + "has_downloads": null + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "version": "2026-03-10" + } + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" ], "properties": { - "reviewer_id": { + "id": { + "description": "Unique identifier of the GitHub app", "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] }, - "reviewer_type": { + "html_url": { "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" ] }, - "mode": { + "created_at": { "type": "string", - "description": "The bypass mode for the reviewer", - "enum": [ - "ALWAYS", - "EXEMPT" - ], - "default": "ALWAYS" + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] } - } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] } - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ], - "x-github-breaking-changes": [ - { - "changeset": "remove_has_downloads", - "patch": { - "properties": { - "has_downloads": null - } - }, - "version": "2026-03-10" - } - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - }, - "secret_scanning_delegated_alert_dismissal": { - "status": "disabled" - } - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "activity", - "subcategory": "watching" - } - } - }, - "/user/teams": { - "get": { - "summary": "List teams for the authenticated user", - "description": "List all of the teams across all of the organizations to which the authenticated\nuser belongs.\n\nOAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint.\n\nWhen using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.", - "tags": [ - "teams" - ], - "operationId": "teams/list-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-teams-for-the-authenticated-user" - }, - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } + ] }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } }, - "filled_seats": { - "type": "integer" + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } }, - "seats": { - "type": "integer" - } + "required": [ + "total", + "completed", + "percent_completed" + ] }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "examples": [ - "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "teams", - "subcategory": "teams" - } - } - }, - "/user/{account_id}": { - "get": { - "summary": "Get a user using their ID", - "description": "Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).", - "tags": [ - "users" - ], - "operationId": "users/get-by-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/users/users#get-a-user-using-their-id" - }, - "parameters": [ - { - "name": "account_id", - "description": "account_id parameter", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "title": "Private User", - "description": "Private User", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ], - "examples": [ - "monalisa octocat" - ] - }, - "company": { - "type": [ - "string", - "null" - ], - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": [ - "string", - "null" - ], - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ], - "examples": [ - "There once was..." - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "monalisa" - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "private_gists": { - "type": "integer", - "examples": [ - 81 - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "disk_usage": { - "type": "integer", - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": "integer", - "examples": [ - 8 - ] - }, - "two_factor_authentication": { - "type": "boolean", - "examples": [ - true - ] - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" + "parent_issue_url": { + "description": "URL to get the parent issue of this issue, if it is a sub-issue", + "type": [ + "string", + "null" + ], + "format": "uri" }, - "name": { - "type": "string" + "pinned_comment": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/comments/1" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string", + "examples": [ + "What version of Safari were you using when you observed this bug?" + ] + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "pinned_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "pinned_at", + "pinned_by" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ] + } + ] }, - "space": { - "type": "integer" + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] }, - "private_repos": { - "type": "integer" + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "examples": [ + "Sample text" + ] + }, + { + "type": "number", + "examples": [ + 42.5 + ] + }, + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the option", + "type": "string", + "examples": [ + "High" + ] + }, + "color": { + "description": "The color of the option", + "type": "string", + "examples": [ + "red" + ] + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } } }, "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "business_plus": { - "type": "boolean" - }, - "ldap_dn": { - "type": "string" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at", - "collaborators", - "disk_usage", - "owned_private_repos", - "private_gists", - "total_private_repos", - "two_factor_authentication" - ] - }, - { - "title": "Public User", - "description": "Public User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "created_at", + "updated_at" ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" + "x-github-breaking-changes": [ + { + "changeset": "deprecate_beta_media_type", + "patch": { + "properties": { + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "nullable": false + }, + "diff_url": { + "nullable": false + }, + "html_url": { + "nullable": false + }, + "patch_url": { + "nullable": false + }, + "url": { + "nullable": false + } + } + } + } + }, + "version": "2026-03-10" }, - "private_repos": { - "type": "integer" + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": { + "properties": { + "assignee": null + }, + "required": [ + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "created_at", + "updated_at" + ] + }, + "version": "2026-03-10" } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "private_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "disk_usage": { - "type": "integer", - "examples": [ - 1 ] }, - "collaborators": { - "type": "integer", - "examples": [ - 3 - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false - } - ] - }, - "examples": { - "default-response": { - "summary": "Default response", - "value": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z" - } - }, - "response-with-git-hub-plan-information": { - "summary": "Response with GitHub plan information", - "value": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z", - "plan": { - "name": "pro", - "space": 976562499, - "collaborators": 0, - "private_repos": 9999 - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "users" - } - } - }, - "/user/{user_id}/projectsV2/{project_number}/drafts": { - "post": { - "summary": "Create draft item for user owned project", - "description": "Create draft issue item for the specified user owned project.", - "tags": [ - "projects" - ], - "operationId": "projects/create-draft-item-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project" - }, - "parameters": [ - { - "name": "user_id", - "description": "The unique identifier of the user.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_number", - "description": "The project's number.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "description": "Details of the draft item to create in the project.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "The title of the draft issue item to create in the project." - }, - "body": { - "type": "string", - "description": "The body content of the draft issue item to create in the project." - } - }, - "required": [ - "title" - ] - }, - "examples": { - "title": { - "summary": "Example with Sample Draft Issue Title", - "value": { - "title": "Sample Draft Issue Title" - } - }, - "body": { - "summary": "Example with Sample Draft Issue Title and Body", - "value": { - "title": "Sample Draft Issue Title", - "body": "This is the body content of the draft issue." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Projects v2 Item", - "description": "An item belonging to a project", - "type": "object", - "properties": { - "id": { - "type": "number", - "description": "The unique identifier of the project item." - }, - "node_id": { - "type": "string", - "description": "The node ID of the project item." - }, - "content": { - "oneOf": [ { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "title": "Pull Request Simple", + "description": "Pull Request Simple", "type": "object", "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/1347" + ] + }, "id": { "type": "integer", - "format": "int64" + "format": "int64", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" + "type": "string", + "examples": [ + "MDExOlB1bGxSZXF1ZXN0MQ==" + ] }, - "url": { - "description": "URL for the issue", + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repositories/42/issues/1" + "https://github.com/octocat/Hello-World/pull/1347" ] }, - "repository_url": { + "diff_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/pull/1347.diff" + ] }, - "labels_url": { - "type": "string" + "patch_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/pull/1347.patch" + ] }, - "comments_url": { + "issue_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] }, - "events_url": { + "commits_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" + ] }, - "html_url": { + "review_comments_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" + ] + }, + "review_comment_url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] }, "number": { - "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ - 42 + 1347 ] }, "state": { - "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], - "examples": [ - "not_planned" - ] + "locked": { + "type": "boolean", + "examples": [ + true + ] + }, + "title": { + "type": "string", + "examples": [ + "new-feature" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body": { + "type": [ + "string", + "null" + ], + "examples": [ + "Please pull these awesome changes" + ] + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "examples": [ + "too heated" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "merge_commit_sha": { + "type": [ + "string", + "null" + ], + "examples": [ + "e5bd3914e2e596debea16f433f57875b5b90bcd6" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } }, - "title": { - "description": "Title of the issue", - "type": "string", - "examples": [ - "Widget creation fails in Safari on OS X 10.8" - ] + "requested_reviewers": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ], - "examples": [ - "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" - ] + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent", + "type" + ] + } }, - "user": { - "anyOf": [ - { - "type": "null" + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" }, - { - "title": "Simple User", - "description": "A GitHub user.", + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ], + "examples": [ + "all" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { "type": [ "string", "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": { + "properties": { + "use_squash_pr_title_as_default": null + } + }, + "version": "2026-03-10" + }, + { + "changeset": "deprecate_beta_media_type", + "patch": { + "properties": { + "master_branch": null + } + }, + "version": "2026-03-10" + }, + { + "changeset": "remove_has_downloads", + "patch": { + "properties": { + "has_downloads": null + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "version": "2026-03-10" + } + ] + }, + "sha": { + "type": "string" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "label", + "ref", + "repo", + "sha", + "user" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" ] }, - "email": { - "type": [ - "string", - "null" + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "login": { + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", + "format": "uri", "examples": [ - "octocat" + "https://github.com/octocat/Hello-World" ] }, - "id": { - "type": "integer", - "format": "int64", + "description": { + "type": [ + "string", + "null" + ], "examples": [ - 1 + "This your first repo!" ] }, - "node_id": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "MDQ6VXNlcjE=" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "avatar_url": { + "archive_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "assignees_url": { + "type": "string", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "url": { + "blobs_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "html_url": { + "branches_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, - "followers_url": { + "collaborators_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, - "following_url": { + "comments_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, - "gists_url": { + "commits_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, - "starred_url": { + "compare_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, - "subscriptions_url": { + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "organizations_url": { + "deployments_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "repos_url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "received_events_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "type": { + "git_commits_url": { "type": "string", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "git_refs_url": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "user_view_type": { + "git_tags_url": { "type": "string", "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - }, - "examples": [ - "bug", - "registration" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "email": { - "type": [ - "string", - "null" + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" ] }, - "login": { + "issue_comment_url": { "type": "string", "examples": [ - "octocat" + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, - "id": { - "type": "integer", - "format": "int64", + "issue_events_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, - "node_id": { + "issues_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, - "avatar_url": { + "keys_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "labels_url": { + "type": "string", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, - "url": { + "languages_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "html_url": { + "merges_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "followers_url": { + "milestones_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, - "following_url": { + "notifications_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, - "gists_url": { + "pulls_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, - "starred_url": { + "releases_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, - "subscriptions_url": { + "ssh_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "git@github.com:octocat/Hello-World.git" ] }, - "organizations_url": { + "stargazers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "repos_url": { + "statuses_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "events_url": { + "subscribers_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "received_events_url": { + "subscription_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "type": { + "tags_url": { "type": "string", + "format": "uri", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/tags" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "teams_url": { "type": "string", + "format": "uri", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "http://api.github.com/repos/octocat/Hello-World/teams" ] }, - "user_view_type": { + "trees_url": { "type": "string", "examples": [ - "public" + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { + }, + "clone_url": { "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" + "git:git.example.com/octocat/Hello-World" ] }, - "html_url": { + "hooks_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" + "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, - "labels_url": { + "svn_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + "https://svn.github.com/octocat/Hello-World" ] }, - "id": { + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { "type": "integer", "examples": [ - 1002604 + 9 ] }, - "node_id": { - "type": "string", + "stargazers_count": { + "type": "integer", "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" + 80 ] }, - "number": { - "description": "The number of the milestone.", + "watchers_count": { "type": "integer", "examples": [ - 42 + 80 ] }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", "examples": [ - "open" + 108 ] }, - "title": { - "description": "The title of the milestone.", + "default_branch": { + "description": "The default branch of the repository.", "type": "string", "examples": [ - "v1.0" + "master" ] }, - "description": { - "type": [ - "string", - "null" - ], + "open_issues_count": { + "type": "integer", "examples": [ - "Tracking milestone for version 1.0" + 0 ] }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true ] }, - "open_issues": { - "type": "integer", + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", "examples": [ - 4 + true ] }, - "closed_issues": { - "type": "integer", + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", "examples": [ - 8 + true ] }, - "created_at": { - "type": "string", - "format": "date-time", + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", "examples": [ - "2011-04-10T20:09:31Z" + true ] }, - "updated_at": { + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", + "enum": [ + "all", + "collaborators_only" + ], + "examples": [ + "all" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2011-01-26T19:06:43Z" ] }, - "closed_at": { + "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ - "2013-02-12T13:22:01Z" + "2011-01-26T19:01:12Z" ] }, - "due_on": { + "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ - "2012-10-09T23:39:01Z" + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } } }, "required": [ - "closed_issues", - "creator", + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", "description", - "due_on", - "closed_at", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", "id", "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", "created_at", "updated_at" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": { + "properties": { + "use_squash_pr_title_as_default": null + } + }, + "version": "2026-03-10" + }, + { + "changeset": "deprecate_beta_media_type", + "patch": { + "properties": { + "master_branch": null + } + }, + "version": "2026-03-10" + }, + { + "changeset": "remove_has_downloads", + "patch": { + "properties": { + "has_downloads": null + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "version": "2026-03-10" + } + ] + }, + "sha": { + "type": "string" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] } + }, + "required": [ + "label", + "ref", + "repo", + "sha", + "user" ] }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { + "_links": { "type": "object", "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "comments": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "commits": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "statuses": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "html": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "issue": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] } }, "required": [ - "diff_url", - "html_url", - "patch_url", - "url" + "comments", + "commits", + "statuses", + "html", + "issue", + "review_comments", + "review_comment", + "self" ] }, - "closed_at": { + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "auto_merge": { + "title": "Auto merge", + "description": "The status of auto merging a pull request.", "type": [ - "string", + "object", "null" ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { + "properties": { + "enabled_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -764395,209 +778319,187 @@ "type", "url" ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." }, - "name": { + "merge_method": { "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", + "description": "The merge method to use.", "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null + "merge", + "squash", + "rebase" ] }, - "created_at": { + "commit_title": { "type": "string", - "description": "The time the issue type created.", - "format": "date-time" + "description": "Title for the merge commit message." }, - "updated_at": { + "commit_message": { "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." + "description": "Commit message for the merge commit." } }, "required": [ - "id", - "node_id", - "name", - "description" + "enabled_by", + "merge_method", + "commit_title", + "commit_message" ] }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean", + "examples": [ + false + ] + } + }, + "required": [ + "_links", + "assignee", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merge_commit_sha", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": { + "properties": { + "merge_commit_sha": null }, - "forks": { - "type": "integer" + "required": [ + "_links", + "assignee", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge" + ] + }, + "version": "2026-03-10" + }, + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": { + "properties": { + "assignee": null }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "required": [ + "_links", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge" + ] + }, + "version": "2026-03-10" + } + ] + }, + { + "title": "Draft Issue", + "description": "A draft issue in a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The ID of the draft issue" + }, + "node_id": { + "type": "string", + "description": "The node ID of the draft issue" + }, + "title": { + "type": "string", + "description": "The title of the draft issue" + }, + "body": { + "type": [ + "string", + "null" + ], + "description": "The body content of the draft issue" + }, + "user": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -764764,3320 +778666,3286 @@ "type", "url" ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ], - "examples": [ - "all" - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ], - "x-github-breaking-changes": [ - { - "changeset": "remove_use_squash_pr_title_as_default", - "patch": { - "properties": { - "use_squash_pr_title_as_default": null - } - }, - "version": "2026-03-10" - }, - { - "changeset": "deprecate_beta_media_type", - "patch": { - "properties": { - "master_branch": null - } - }, - "version": "2026-03-10" - }, - { - "changeset": "remove_has_downloads", - "patch": { - "properties": { - "has_downloads": null - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "version": "2026-03-10" } ] }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time the draft issue was created" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time the draft issue was last updated" + } + }, + "required": [ + "id", + "node_id", + "title", + "user", + "created_at", + "updated_at" + ] + } + ], + "description": "The content represented by the item." + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the item was archived.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "description": "The URL of the project this item belongs to." + }, + "item_url": { + "type": "string", + "format": "uri", + "description": "The URL of the item in the project." + } + }, + "required": [ + "id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "examples": { + "draft_issue": { + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "drafts" + } + } + }, + "/users": { + "get": { + "summary": "List users", + "description": "Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.", + "tags": [ + "users" + ], + "operationId": "users/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/users#list-users" + }, + "parameters": [ + { + "name": "since", + "description": "A user ID. Only return users with an ID greater than this ID.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "description": "Not modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" + } + } + }, + "/users/{user_id}/projectsV2/{project_number}/views": { + "post": { + "summary": "Create a view for a user-owned project", + "description": "Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered.", + "tags": [ + "projects" + ], + "operationId": "projects/create-view-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project" + }, + "parameters": [ + { + "name": "user_id", + "description": "The unique identifier of the user.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_number", + "description": "The project's number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the view.", + "examples": [ + "Sprint Board" + ] + }, + "layout": { + "type": "string", + "description": "The layout of the view.", + "enum": [ + "table", + "board", + "roadmap" + ], + "examples": [ + "board" + ] + }, + "filter": { + "type": "string", + "description": "The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", + "examples": [ + "is:issue is:open" + ] + }, + "visible_fields": { + "type": "array", + "description": "`visible_fields` is not applicable to `roadmap` layout views.\nFor `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used.", + "items": { + "type": "integer" + }, + "examples": [ + 123, + 456, + 789 + ] + } + }, + "required": [ + "name", + "layout" + ], + "additionalProperties": false + }, + "examples": { + "table_view": { + "summary": "Create a table view", + "value": { + "name": "All Issues", + "layout": "table", + "filter": "is:issue", + "visible_fields": [ + 123, + 456, + 789 + ] + } + }, + "board_view": { + "summary": "Create a board view with filter", + "value": { + "name": "Sprint Board", + "layout": "board", + "filter": "is:issue is:open label:sprint", + "visible_fields": [ + 123, + 456, + 789 + ] + } + }, + "roadmap_view": { + "summary": "Create a roadmap view", + "value": { + "name": "Product Roadmap", + "layout": "roadmap" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response for creating a view in a user-owned project.", + "content": { + "application/json": { + "schema": { + "title": "Projects v2 View", + "description": "A view inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the view." + }, + "number": { + "type": "integer", + "description": "The number of the view within the project." + }, + "name": { + "type": "string", + "description": "The name of the view." + }, + "layout": { + "type": "string", + "description": "The layout of the view.", + "enum": [ + "table", + "board", + "roadmap" + ] + }, + "node_id": { + "type": "string", + "description": "The node ID of the view." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the view.", + "examples": [ + "https://api.github.com/orgs/octocat/projectsV2/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The web URL of the view.", + "examples": [ + "https://github.com/orgs/octocat/projects/1/views/1" + ] + }, + "creator": { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "author_association": { - "title": "author_association", + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], "examples": [ - "OWNER" + "octocat" ] }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 ] }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" ] }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ "string", "null" ], - "format": "uri" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the issue comment", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/comments/1" - ] - }, - "body": { - "description": "Contents of the issue comment", - "type": "string", - "examples": [ - "What version of Safari were you using when you observed this bug?" - ] - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" ] }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the view was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the view was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "filter": { + "type": [ + "string", + "null" + ], + "description": "The filter query for the view.", + "examples": [ + "is:issue is:open" + ] + }, + "visible_fields": { + "type": "array", + "description": "The list of field IDs that are visible in the view.", + "items": { + "type": "integer" + } + }, + "sort_by": { + "type": "array", + "description": "The sorting configuration for the view. Each element is a tuple of [field_id, direction] where direction is \"asc\" or \"desc\".", + "items": { + "type": "array", + "minItems": 2, + "maxItems": 2, + "items": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + }, + "group_by": { + "type": "array", + "description": "The list of field IDs used for horizontal grouping.", + "items": { + "type": "integer" + } + }, + "vertical_group_by": { + "type": "array", + "description": "The list of field IDs used for vertical grouping (board layout).", + "items": { + "type": "integer" + } + } + }, + "required": [ + "id", + "number", + "name", + "layout", + "node_id", + "project_url", + "html_url", + "creator", + "created_at", + "updated_at", + "visible_fields", + "sort_by", + "group_by", + "vertical_group_by" + ] + }, + "examples": { + "table_view": { + "summary": "Response for creating a table view", + "value": { + "value": { + "id": 1, + "number": 1, + "name": "Sprint Board", + "layout": "board", + "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", + "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", + "html_url": "https://github.com/orgs/octocat/projects/1/views/1", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "filter": "is:issue is:open", + "visible_fields": [ + 123, + 456, + 789 + ], + "sort_by": [ + [ + 123, + "asc" + ], + [ + 456, + "desc" + ] + ], + "group_by": [ + 123 + ], + "vertical_group_by": [ + 456 + ] + } + } + }, + "board_view": { + "summary": "Response for creating a board view with filter", + "value": { + "value": { + "id": 1, + "number": 1, + "name": "Sprint Board", + "layout": "board", + "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", + "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", + "html_url": "https://github.com/orgs/octocat/projects/1/views/1", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "filter": "is:issue is:open", + "visible_fields": [ + 123, + 456, + 789 + ], + "sort_by": [ + [ + 123, + "asc" + ], + [ + 456, + "desc" + ] + ], + "group_by": [ + 123 + ], + "vertical_group_by": [ + 456 + ] + } + } + }, + "roadmap_view": { + "summary": "Response for creating a roadmap view", + "value": { + "value": { + "id": 1, + "number": 1, + "name": "Sprint Board", + "layout": "board", + "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", + "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", + "html_url": "https://github.com/orgs/octocat/projects/1/views/1", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "filter": "is:issue is:open", + "visible_fields": [ + 123, + 456, + 789 + ], + "sort_by": [ + [ + 123, + "asc" + ], + [ + 456, + "desc" + ] + ], + "group_by": [ + 123 + ], + "vertical_group_by": [ + 456 + ] + } + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "projects", + "subcategory": "views" + } + } + }, + "/users/{username}": { + "get": { + "summary": "Get a user", + "description": "Provides publicly available information about someone with a GitHub account.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).", + "tags": [ + "users" + ], + "operationId": "users/get-by-username", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/users#get-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "user_view_type": { + "type": "string" + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "user_view_type": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + } + ] + }, + "examples": { + "default-response": { + "summary": "Default response", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "response-with-git-hub-plan-information": { + "summary": "Response with GitHub plan information", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "plan": { + "name": "pro", + "space": 976562499, + "collaborators": 0, + "private_repos": 9999 + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" + } + } + }, + "/users/{username}/attestations/bulk-list": { + "post": { + "summary": "List attestations by bulk subject digests", + "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "users" + ], + "operationId": "users/list-attestations-bulk", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "subject_digests": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of subject digests to fetch attestations for.", + "minItems": 1, + "maxItems": 1024 + }, + "predicate_type": { + "type": "string", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types." + } + }, + "required": [ + "subject_digests" + ] + }, + "examples": { + "default": { + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ] + } + }, + "withPredicateType": { + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ], + "predicateType": "provenance" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations_subject_digests": { + "type": "object", + "additionalProperties": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "bundle": { "type": "object", "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" + "mediaType": { + "type": "string" }, - "total_blocked_by": { - "type": "integer" + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true }, - "total_blocking": { - "type": "integer" + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true } }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] + "description": "The bundle of the attestation." }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + } + } + } + }, + "description": "Mapping of subject digest to bundles." + }, + "page_info": { + "type": "object", + "properties": { + "has_next": { + "type": "boolean", + "description": "Indicates whether there is a next page." + }, + "has_previous": { + "type": "boolean", + "description": "Indicates whether there is a previous page." + }, + "next": { + "type": "string", + "description": "The cursor to the next page." + }, + "previous": { + "type": "string", + "description": "The cursor to the previous page." + } + }, + "description": "Information about the current page." + } + } + }, + "examples": { + "default": { + "value": { + "attestations_subject_digests": [ + { + "sha256:abc": [ + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" }, - { - "type": "number", - "examples": [ - 42.5 - ] + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" } }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "required": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "created_at", - "updated_at" - ], - "x-github-breaking-changes": [ + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + }, { - "changeset": "deprecate_beta_media_type", - "patch": { - "properties": { - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "nullable": false + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" }, - "diff_url": { - "nullable": false + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" }, - "html_url": { - "nullable": false + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" }, - "patch_url": { - "nullable": false + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } }, - "url": { - "nullable": false - } + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" } - } - }, - "version": "2026-03-10" - }, - { - "changeset": "remove_singular_assignee_from_issues_and_pull_requests", - "patch": { - "properties": { - "assignee": null - }, - "required": [ - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "created_at", - "updated_at" - ] - }, - "version": "2026-03-10" - } - ] - }, - { - "title": "Pull Request Simple", - "description": "Pull Request Simple", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/1347" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOlB1bGxSZXF1ZXN0MQ==" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/pull/1347" - ] - }, - "diff_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/pull/1347.diff" - ] - }, - "patch_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/pull/1347.patch" - ] - }, - "issue_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - }, - "commits_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" - ] - }, - "review_comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" - ] - }, - "review_comment_url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" - ] - }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" - ] - }, - "statuses_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1347 - ] - }, - "state": { - "type": "string", - "examples": [ - "open" - ] - }, - "locked": { - "type": "boolean", - "examples": [ - true - ] - }, - "title": { - "type": "string", - "examples": [ - "new-feature" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" ] } - ] - }, - "body": { - "type": [ - "string", - "null" - ], - "examples": [ - "Please pull these awesome changes" - ] - }, - "labels": { - "type": "array", + }, + "repository_id": 1 + } + ] + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_bundle", + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "attestations_subject_digests": { + "additionalProperties": { "items": { - "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ] + "bundle": null } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "examples": [ - "too heated" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ], - "examples": [ - "e5bd3914e2e596debea16f433f57875b5b90bcd6" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + } + } + } + } + } + } + } + } + } + }, + "version": "2026-03-10" + } + ] + } + }, + "/users/{username}/attestations/delete-request": { + "post": { + "summary": "Delete attestations in bulk", + "description": "Delete artifact attestations in bulk by either subject digests or unique ID.", + "tags": [ + "users" + ], + "operationId": "users/delete-attestations-bulk", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "oneOf": [ + { + "properties": { + "subject_digests": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of subject digests associated with the artifact attestations to delete.", + "minItems": 1, + "maxItems": 1024 + } + }, + "required": [ + "subject_digests" + ] + }, + { + "properties": { + "attestation_ids": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of unique IDs associated with the artifact attestations to delete.", + "minItems": 1, + "maxItems": 1024 + } + }, + "required": [ + "attestation_ids" + ] + } + ], + "description": "The request body must include either `subject_digests` or `attestation_ids`, but not both." + }, + "examples": { + "by-subject-digests": { + "summary": "Delete by subject digests", + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ] + } + }, + "by-attestation-ids": { + "summary": "Delete by attestation IDs", + "value": { + "attestation_ids": [ + 111, + 222 + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + } + } + }, + "/users/{username}/attestations/digest/{subject_digest}": { + "delete": { + "summary": "Delete attestations by subject digest", + "description": "Delete an artifact attestation by subject digest.", + "tags": [ + "users" + ], + "operationId": "users/delete-attestations-by-subject-digest", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "subject_digest", + "description": "Subject Digest", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "responses": { + "200": { + "description": "Response" + }, + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + } + } + }, + "/users/{username}/attestations/{attestation_id}": { + "delete": { + "summary": "Delete attestations by ID", + "description": "Delete an artifact attestation by unique ID that is associated with a repository owned by a user.", + "tags": [ + "users" + ], + "operationId": "users/delete-attestations-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/attestations#delete-attestations-by-id" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "attestation_id", + "description": "Attestation ID", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response" + }, + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + } + } + }, + "/users/{username}/attestations/{subject_digest}": { + "get": { + "summary": "List attestations", + "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "users" + ], + "operationId": "users/list-attestations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/attestations#list-attestations" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "subject_digest", + "description": "Subject Digest", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." + }, + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + }, + "initiator": { + "type": "string" + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "attestations": [ + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" } }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" } ] + } + }, + "repository_id": 1 + }, + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } }, - "assignees": { - "type": "array", - "items": { + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + } + ] + } + } + } + } + } + }, + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_bundle", + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "attestations": { + "items": { + "properties": { + "bundle": null + } + } + } + } + } + } + } + } + } + }, + "version": "2026-03-10" + } + ] + } + }, + "/users/{username}/copilot-spaces": { + "get": { + "summary": "List Copilot Spaces for a user", + "description": "Lists Copilot Spaces owned by a user. The authenticated user must have read access to the user's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes the user's own spaces, and public user spaces when accessing another user's spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-copilot-spaces-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "spaces" + ], + "properties": { + "spaces": { + "type": "array", + "description": "The list of Copilot Spaces on this page of results.", + "items": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { + "anyOf": [ + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -768244,36 +782112,20 @@ "type", "url" ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, "login": { "type": "string", "examples": [ - "octocat" + "github" ] }, "id": { "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -768281,3629 +782133,2875 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "https://api.github.com/orgs/github" ] }, - "organizations_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://api.github.com/orgs/github/repos" ] }, - "repos_url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/orgs/github/events" ] }, - "events_url": { + "hooks_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "https://api.github.com/orgs/github/hooks" ] }, - "received_events_url": { + "issues_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "https://api.github.com/orgs/github/issues" ] }, - "type": { + "members_url": { "type": "string", "examples": [ - "User" + "https://api.github.com/orgs/github/members{/member}" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "public_members_url": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "https://api.github.com/orgs/github/public_members{/member}" ] }, - "user_view_type": { + "avatar_url": { "type": "string", "examples": [ - "public" + "https://github.com/images/error/octocat_happy.gif" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" }, "description": { "type": [ "string", "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", + ], "examples": [ - 42 - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } + "A great organization" ] } }, "required": [ + "login", + "url", "id", "node_id", - "url", + "repos_url", + "events_url", + "hooks_url", + "issues_url", "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" + "public_members_url", + "avatar_url", + "description" ] } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ], - "examples": [ - "all" - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ], - "x-github-breaking-changes": [ - { - "changeset": "remove_use_squash_pr_title_as_default", - "patch": { - "properties": { - "use_squash_pr_title_as_default": null - } - }, - "version": "2026-03-10" - }, - { - "changeset": "deprecate_beta_media_type", - "patch": { - "properties": { - "master_branch": null - } - }, - "version": "2026-03-10" - }, - { - "changeset": "remove_has_downloads", - "patch": { - "properties": { - "has_downloads": null - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "version": "2026-03-10" - } - ] - }, - "sha": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "base": { + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { "type": "object", "properties": { - "label": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." }, - "ref": { - "type": "string" + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { "type": "object", + "description": "Metadata specific to the resource type.", "properties": { - "id": { - "description": "Unique identifier of the repository", + "repository_id": { "type": "integer", - "format": "int64", - "examples": [ - 42 - ] + "description": "Repository ID for repository or file resources." }, - "node_id": { + "file_path": { "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "description": "File path for file resources." }, - "name": { - "description": "The name of the repository.", + "text": { "type": "string", - "examples": [ - "Team Environment" - ] + "description": "Text content for free text resources." }, - "full_name": { + "name": { "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "description": "Name for the resource." }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "number": { + "type": "integer", + "description": "Issue or PR number." }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." }, - "html_url": { + "media_type": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" + "description": "Media type for media content resources." }, "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] + "description": "URL for media content resources." }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "height": { "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] + "description": "Height for media content resources." }, - "open_issues_count": { + "width": { "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ], - "examples": [ - "all" - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ], - "x-github-breaking-changes": [ - { - "changeset": "remove_use_squash_pr_title_as_default", - "patch": { - "properties": { - "use_squash_pr_title_as_default": null - } - }, - "version": "2026-03-10" - }, - { - "changeset": "deprecate_beta_media_type", - "patch": { - "properties": { - "master_branch": null - } - }, - "version": "2026-03-10" - }, - { - "changeset": "remove_has_downloads", - "patch": { - "properties": { - "has_downloads": null - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "version": "2026-03-10" + "description": "Width for media content resources." } - ] - }, - "sha": { + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + }, + "examples": { + "default": { + "summary": "Example response for listing user copilot spaces", + "value": { + "spaces": [ + { + "id": 42, + "number": 1, + "name": "Personal Research Space", + "description": "My personal space for research and development", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/1", + "api_url": "https://api.github.com/user/1/copilot-spaces/1" + }, + { + "id": 43, + "number": 2, + "name": "Learning Space", + "description": "Space for learning new technologies", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-17T08:20:00Z", + "updated_at": "2023-02-17T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/2", + "api_url": "https://api.github.com/user/1/copilot-spaces/2" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "post": { + "summary": "Create a Copilot Space for a user", + "description": "Creates a new Copilot Space owned by a user. Only the authenticated user can create spaces for their own account.\n\nUsers can create personal Copilot Spaces for their individual use.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/create-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Personal space for development assistance" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help me with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "no_access" + ], + "description": "The base role that determines default permissions for the space.\n- `no_access`: No default access (default)\n- `reader`: Makes the space publicly readable\nNote: User spaces do not support writer or admin base roles.", + "default": "no_access" + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "My Development Space", + "description": "Personal space for development assistance", + "general_instructions": "Help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/App.js" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Development Notes", + "text": "Focus on clean code principles and modern React patterns" + } + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + }, + "examples": { + "default": { + "summary": "Example response for a user copilot space", + "value": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}": { + "get": { + "summary": "Get a Copilot Space for a user", + "description": "Gets details about a specific Copilot Space owned by a user. The authenticated user must have read access to the Space.\n\nPrivate user spaces require the authenticated user to be the owner of the space.\nPublic user spaces are accessible to any authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/get-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" + "email": { + "type": [ + "string", + "null" ] }, - "author_association": { - "title": "author_association", + "login": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], "examples": [ - "OWNER" + "octocat" ] }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "object", + "string", "null" ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" ] }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean", + "url": { + "type": "string", + "format": "uri", "examples": [ - false + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", "html_url", "id", "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", "url", - "user", - "author_association", - "auto_merge" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" ], - "x-github-breaking-changes": [ - { - "changeset": "remove_pull_request_merge_commit_sha", - "patch": { - "properties": { - "merge_commit_sha": null - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge" - ] + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." }, - "version": "2026-03-10" - }, - { - "changeset": "remove_singular_assignee_from_issues_and_pull_requests", - "patch": { - "properties": { - "assignee": null - }, - "required": [ - "_links", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge" - ] + "file_path": { + "type": "string", + "description": "File path for file resources." }, - "version": "2026-03-10" + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } } - ] + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + }, + "examples": { + "default": { + "summary": "Example response for a user copilot space", + "value": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } }, { - "title": "Draft Issue", - "description": "A draft issue in a project", + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "put": { + "summary": "Set a Copilot Space for a user", + "description": "Updates a Copilot Space owned by a user. Only the authenticated user can update spaces for their own account.\n\nUsers can update their personal Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "Updated Development Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Updated personal space for development assistance" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Updated instructions to help me with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "no_access" + ], + "description": "The base role that determines default permissions for the space. Changing this field requires admin permissions.\n- `no_access`: No default access (default)\n- `reader`: Makes the space publicly readable\nNote: User spaces do not support writer or admin base roles." + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "Updated Development Space", + "description": "Updated personal space for development assistance", + "general_instructions": "Updated instructions to help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/UpdatedApp.js" + } + }, + { + "id": 123, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Development Notes", + "text": "Updated focus on clean code principles and modern React patterns" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { - "type": "number", - "description": "The ID of the draft issue" + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] }, "node_id": { "type": "string", - "description": "The node ID of the draft issue" + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "title": { + "avatar_url": { "type": "string", - "description": "The title of the draft issue" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "body": { + "gravatar_id": { "type": [ "string", "null" ], - "description": "The body content of the draft issue" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" ] }, - "created_at": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", - "format": "date-time", - "description": "The time the draft issue was created" + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] }, - "updated_at": { + "url": { "type": "string", - "format": "date-time", - "description": "The time the draft issue was last updated" + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] } }, "required": [ + "login", + "url", "id", "node_id", - "title", - "user", - "created_at", - "updated_at" + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" ] } ], - "description": "The content represented by the item." - }, - "content_type": { - "title": "Projects v2 Item Content Type", - "description": "The type of content tracked in a project item", - "type": "string", - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] + "description": "The user or organization that owns this space." }, "creator": { "title": "Simple User", @@ -772076,83 +785174,170 @@ "created_at": { "type": "string", "format": "date-time", - "description": "The time when the item was created.", + "description": "The date and time the space was created.", "examples": [ - "2022-04-28T12:00:00Z" + "2023-01-01T00:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", - "description": "The time when the item was last updated.", + "description": "The date and time the space was last updated.", "examples": [ - "2022-04-28T12:00:00Z" + "2023-01-01T12:00:00Z" ] }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time when the item was archived.", + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", "examples": [ - "2022-04-28T12:00:00Z" + "https://github.com/copilot/spaces/octo-org/5" ] }, - "project_url": { + "api_url": { "type": "string", "format": "uri", - "description": "The URL of the project this item belongs to." + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] }, - "item_url": { - "type": "string", - "format": "uri", - "description": "The URL of the item in the project." + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } } }, "required": [ "id", - "content_type", + "number", + "name", + "base_role", + "owner", + "creator", "created_at", "updated_at", - "archived_at" - ] + "html_url", + "api_url" + ], + "additionalProperties": false }, "examples": { - "draft_issue": { + "default": { + "summary": "Example response for a user copilot space", "value": { - "id": 17, - "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", - "content": { - "id": 38, - "node_id": "I_kwDOANN5s85FtLts", - "title": "Example Draft Issue", - "body": "This is a draft issue in the project.", - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false }, - "content_type": "DraftIssue", "creator": { "login": "octocat", "id": 1, @@ -772173,20 +785358,35 @@ "type": "User", "site_admin": false }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "archived_at": null, - "project_url": "https://api.github.com/users/octocat/projectsV2/1", - "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] } } } } } }, - "304": { - "description": "Not modified" - }, "403": { "description": "Forbidden", "content": { @@ -772213,8 +785413,8 @@ } } }, - "401": { - "description": "Requires authentication", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -772238,45 +785438,262 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects", - "subcategory": "drafts" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "delete": { + "summary": "Delete a Copilot Space for a user", + "description": "Deletes a Copilot Space owned by a user. The authenticated user must be the owner of the space.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a space will remove all associated resources and configurations.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/delete-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "The Copilot Space has been successfully deleted." + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } } }, - "/users": { + "/users/{username}/copilot-spaces/{space_number}/collaborators": { "get": { - "summary": "List users", - "description": "Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.", + "summary": "List collaborators for a Copilot Space for a user", + "description": "Lists all collaborators for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nEach collaborator entry specifies which user has access to the space and at what level (reader, writer, or admin). The space owner is excluded from this list.\n\nTeam collaborators are not supported for user-owned Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/list", + "operationId": "copilot-spaces/list-collaborators-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/users/users#list-users" + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-a-copilot-space-for-a-user" }, "parameters": [ { - "name": "since", - "description": "A user ID. Only return users with an ID greater than this ID.", - "in": "query", - "required": false, + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "integer" } } ], @@ -772286,241 +785703,463 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" + "type": "object", + "required": [ + "collaborators" + ], + "properties": { + "collaborators": { + "type": "array", + "description": "The list of collaborators for this Copilot Space.", + "items": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } ] } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + } } }, "examples": { "default": { - "value": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ] + "value": { + "collaborators": [ + { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "User", + "role": "reader", + "login": "github-user", + "id": 67890, + "node_id": "MDQ6VXNlcjY3ODkw", + "avatar_url": "https://github.com/images/error/other_user.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github-user", + "html_url": "https://github.com/github-user", + "followers_url": "https://api.github.com/users/github-user/followers", + "following_url": "https://api.github.com/users/github-user/following{/other_user}", + "gists_url": "https://api.github.com/users/github-user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github-user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github-user/subscriptions", + "organizations_url": "https://api.github.com/users/github-user/orgs", + "repos_url": "https://api.github.com/users/github-user/repos", + "events_url": "https://api.github.com/users/github-user/events{/privacy}", + "received_events_url": "https://api.github.com/users/github-user/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "GitHub User", + "company": null, + "blog": "", + "location": null, + "email": null, + "hireable": null, + "bio": null, + "twitter_username": null, + "public_repos": 5, + "public_gists": 0, + "followers": 10, + "following": 5, + "created_at": "2010-01-14T04:33:35Z", + "updated_at": "2010-01-14T04:33:35Z" + } + ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\"", + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } } } } }, - "304": { - "description": "Not modified" + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "users" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" } - } - }, - "/users/{user_id}/projectsV2/{project_number}/views": { + }, "post": { - "summary": "Create a view for a user-owned project", - "description": "Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered.", + "summary": "Add a collaborator to a Copilot Space for a user", + "description": "Adds a collaborator to a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nTeam collaborators are not supported for user-owned Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", "tags": [ - "projects" + "copilot-spaces" ], - "operationId": "projects/create-view-for-user", + "operationId": "copilot-spaces/add-collaborator-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project" + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-a-copilot-space-for-a-user" }, "parameters": [ { - "name": "user_id", - "description": "The unique identifier of the user.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { @@ -772528,8 +786167,8 @@ } }, { - "name": "project_number", - "description": "The project's number.", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { @@ -772543,84 +786182,41 @@ "application/json": { "schema": { "type": "object", + "required": [ + "actor_type", + "actor_identifier", + "role" + ], "properties": { - "name": { - "type": "string", - "description": "The name of the view.", - "examples": [ - "Sprint Board" - ] - }, - "layout": { + "actor_type": { "type": "string", - "description": "The layout of the view.", "enum": [ - "table", - "board", - "roadmap" + "User", + "Team" ], - "examples": [ - "board" - ] + "description": "The type of actor (must be `User` for user-owned spaces; `Team` will be rejected)." }, - "filter": { + "actor_identifier": { "type": "string", - "description": "The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", - "examples": [ - "is:issue is:open" - ] + "description": "The username of the collaborator. The numeric user ID is also accepted." }, - "visible_fields": { - "type": "array", - "description": "`visible_fields` is not applicable to `roadmap` layout views.\nFor `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used.", - "items": { - "type": "integer" - }, - "examples": [ - 123, - 456, - 789 - ] + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role to grant to the collaborator." } - }, - "required": [ - "name", - "layout" - ], - "additionalProperties": false + } }, "examples": { - "table_view": { - "summary": "Create a table view", - "value": { - "name": "All Issues", - "layout": "table", - "filter": "is:issue", - "visible_fields": [ - 123, - 456, - 789 - ] - } - }, - "board_view": { - "summary": "Create a board view with filter", - "value": { - "name": "Sprint Board", - "layout": "board", - "filter": "is:issue is:open label:sprint", - "visible_fields": [ - 123, - 456, - 789 - ] - } - }, - "roadmap_view": { - "summary": "Create a roadmap view", + "default": { "value": { - "name": "Product Roadmap", - "layout": "roadmap" + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" } } } @@ -772629,55 +786225,15 @@ }, "responses": { "201": { - "description": "Response for creating a view in a user-owned project.", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Projects v2 View", - "description": "A view inside a projects v2 project", + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the view." - }, - "number": { - "type": "integer", - "description": "The number of the view within the project." - }, - "name": { - "type": "string", - "description": "The name of the view." - }, - "layout": { - "type": "string", - "description": "The layout of the view.", - "enum": [ - "table", - "board", - "roadmap" - ] - }, - "node_id": { - "type": "string", - "description": "The node ID of the view." - }, - "project_url": { - "type": "string", - "description": "The API URL of the project that contains the view.", - "examples": [ - "https://api.github.com/orgs/octocat/projectsV2/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The web URL of the view.", - "examples": [ - "https://github.com/orgs/octocat/projects/1/views/1" - ] - }, - "creator": { + "anyOf": [ + { "allOf": [ { "title": "Simple User", @@ -772846,274 +786402,722 @@ "type", "url" ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] } ] }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The time when the view was created.", - "examples": [ - "2022-04-28T12:00:00Z" + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" ] + } + ] + }, + "examples": { + "default": { + "value": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The time when the view was last updated.", - "examples": [ - "2022-04-28T12:00:00Z" - ] + "documentation_url": { + "type": "string" }, - "filter": { - "type": [ - "string", - "null" - ], - "description": "The filter query for the view.", - "examples": [ - "is:issue is:open" - ] + "url": { + "type": "string" }, - "visible_fields": { - "type": "array", - "description": "The list of field IDs that are visible in the view.", - "items": { - "type": "integer" - } + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "sort_by": { + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", - "description": "The sorting configuration for the view. Each element is a tuple of [field_id, direction] where direction is \"asc\" or \"desc\".", "items": { - "type": "array", - "minItems": 2, - "maxItems": 2, - "items": { - "oneOf": [ - { - "type": "integer" + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { + "put": { + "summary": "Set a collaborator role for a Copilot Space for a user", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-collaborator-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "The type of actor (must be `User` for user-owned spaces; `Team` will be rejected).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username of the collaborator. The numeric user ID is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "role" + ], + "properties": { + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The new role to grant to the collaborator. Use `no_access` to remove the collaborator." + } + } + }, + "examples": { + "default": { + "value": { + "role": "admin" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - { - "type": "string" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" } + }, + "required": [ + "actor_type", + "role" ] } - } - }, - "group_by": { - "type": "array", - "description": "The list of field IDs used for horizontal grouping.", - "items": { - "type": "integer" - } + ] }, - "vertical_group_by": { - "type": "array", - "description": "The list of field IDs used for vertical grouping (board layout).", - "items": { - "type": "integer" - } - } - }, - "required": [ - "id", - "number", - "name", - "layout", - "node_id", - "project_url", - "html_url", - "creator", - "created_at", - "updated_at", - "visible_fields", - "sort_by", - "group_by", - "vertical_group_by" - ] - }, - "examples": { - "table_view": { - "summary": "Response for creating a table view", - "value": { - "value": { - "id": 1, - "number": 1, - "name": "Sprint Board", - "layout": "board", - "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", - "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", - "html_url": "https://github.com/orgs/octocat/projects/1/views/1", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "filter": "is:issue is:open", - "visible_fields": [ - 123, - 456, - 789 - ], - "sort_by": [ - [ - 123, - "asc" + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" ], - [ - 456, - "desc" + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" ] - ], - "group_by": [ - 123 - ], - "vertical_group_by": [ - 456 - ] - } - } - }, - "board_view": { - "summary": "Response for creating a board view with filter", - "value": { - "value": { - "id": 1, - "number": 1, - "name": "Sprint Board", - "layout": "board", - "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", - "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", - "html_url": "https://github.com/orgs/octocat/projects/1/views/1", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "filter": "is:issue is:open", - "visible_fields": [ - 123, - 456, - 789 - ], - "sort_by": [ - [ - 123, - "asc" - ], - [ - 456, - "desc" + "description": { + "type": [ + "string", + "null" ] - ], - "group_by": [ - 123 - ], - "vertical_group_by": [ - 456 - ] - } - } - }, - "roadmap_view": { - "summary": "Response for creating a roadmap view", - "value": { - "value": { - "id": 1, - "number": 1, - "name": "Sprint Board", - "layout": "board", - "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", - "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", - "html_url": "https://github.com/orgs/octocat/projects/1/views/1", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "filter": "is:issue is:open", - "visible_fields": [ - 123, - 456, - 789 - ], - "sort_by": [ - [ - 123, - "asc" - ], - [ - 456, - "desc" + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" ] - ], - "group_by": [ - 123 - ], - "vertical_group_by": [ - 456 - ] - } + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + }, + "examples": { + "default": { + "value": { + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" } } } } } }, - "304": { - "description": "Not modified" + "204": { + "description": "Response when `role` is `no_access` and the collaborator was removed." }, "403": { "description": "Forbidden", @@ -773141,32 +787145,6 @@ } } }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "404": { "description": "Resource not found", "content": { @@ -773267,9 +787245,99 @@ } } } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + }, + "delete": { + "summary": "Remove a collaborator from a Copilot Space for a user", + "description": "Removes a collaborator from a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/remove-collaborator-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "503": { - "description": "Service unavailable", + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "The type of actor (must be `User` for user-owned spaces; `Team` will be rejected).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username of the collaborator. The numeric user ID is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -773296,24 +787364,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": false, - "category": "projects", - "subcategory": "views" + "category": "copilot-spaces", + "subcategory": "collaborators" } } }, - "/users/{username}": { + "/users/{username}/copilot-spaces/{space_number}/resources": { "get": { - "summary": "Get a user", - "description": "Provides publicly available information about someone with a GitHub account.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).", + "summary": "List resources for a Copilot Space for a user", + "description": "Lists all resources attached to a specific Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/get-by-username", + "operationId": "copilot-spaces/list-resources-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/users/users#get-a-user" + "url": "https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-a-copilot-space-for-a-user" }, "parameters": [ { @@ -773324,6 +787391,15 @@ "schema": { "type": "string" } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { @@ -773332,676 +787408,112 @@ "content": { "application/json": { "schema": { - "oneOf": [ - { - "title": "Private User", - "description": "Private User", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ], - "examples": [ - "monalisa octocat" - ] - }, - "company": { - "type": [ - "string", - "null" - ], - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": [ - "string", - "null" - ], - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ], - "examples": [ - "There once was..." - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "monalisa" - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "private_gists": { - "type": "integer", - "examples": [ - 81 - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "disk_usage": { - "type": "integer", - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": "integer", - "examples": [ - 8 - ] - }, - "two_factor_authentication": { - "type": "boolean", - "examples": [ - true - ] - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } + "type": "object", + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "business_plus": { - "type": "boolean" - }, - "ldap_dn": { - "type": "string" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at", - "collaborators", - "disk_usage", - "owned_private_repos", - "private_gists", - "total_private_repos", - "two_factor_authentication" - ] - }, - { - "title": "Public User", - "description": "Public User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "private_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "disk_usage": { - "type": "integer", - "examples": [ - 1 - ] + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } }, - "collaborators": { - "type": "integer", - "examples": [ - 3 - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } } - ] + } }, "examples": { - "default-response": { - "summary": "Default response", + "default": { "value": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z" + "resources": [ + { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + ] } - }, - "response-with-git-hub-plan-information": { - "summary": "Response with GitHub plan information", - "value": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z", - "plan": { - "name": "pro", - "space": 976562499, - "collaborators": 0, - "private_repos": 9999 - } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -774036,60 +787548,39 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "users" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/users/{username}/attestations/bulk-list": { + }, "post": { - "summary": "List attestations by bulk subject digests", - "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "summary": "Create a resource for a Copilot Space for a user", + "description": "Creates a new resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/list-attestations-bulk", + "operationId": "copilot-spaces/create-resource-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests" + "url": "https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-a-copilot-space-for-a-user" }, "parameters": [ { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, "schema": { "type": "string" } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -774099,41 +787590,55 @@ "application/json": { "schema": { "type": "object", + "required": [ + "resource_type", + "metadata" + ], "properties": { - "subject_digests": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of subject digests to fetch attestations for.", - "minItems": 1, - "maxItems": 1024 - }, - "predicate_type": { + "resource_type": { "type": "string", - "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types." + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ], + "description": "The type of resource to create." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata.", + "additionalProperties": true } - }, - "required": [ - "subject_digests" - ] + } }, "examples": { - "default": { + "free_text": { "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" - ] + "resource_type": "free_text", + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + } } }, - "withPredicateType": { + "repository": { "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" - ], - "predicateType": "provenance" + "resource_type": "repository", + "metadata": { + "repository_id": 42 + } + } + }, + "github_file": { + "value": { + "resource_type": "github_file", + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + } } } } @@ -774141,343 +787646,182 @@ } }, "responses": { - "200": { - "description": "Response", + "201": { + "description": "Resource created", "content": { "application/json": { "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", "type": "object", "properties": { - "attestations_subject_digests": { - "type": "object", - "additionalProperties": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "bundle": { - "type": "object", - "properties": { - "mediaType": { - "type": "string" - }, - "verificationMaterial": { - "type": "object", - "properties": {}, - "additionalProperties": true - }, - "dsseEnvelope": { - "type": "object", - "properties": {}, - "additionalProperties": true - } - }, - "description": "The bundle of the attestation." - }, - "repository_id": { - "type": "integer" - }, - "bundle_url": { - "type": "string" - } - } - } - }, - "description": "Mapping of subject digest to bundles." + "id": { + "type": "integer", + "description": "The unique identifier of the resource." }, - "page_info": { + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { "type": "object", - "properties": { - "has_next": { - "type": "boolean", - "description": "Indicates whether there is a next page." - }, - "has_previous": { - "type": "boolean", - "description": "Indicates whether there is a previous page." - }, - "next": { - "type": "string", - "description": "The cursor to the next page." - }, - "previous": { - "type": "string", - "description": "The cursor to the previous page." - } - }, - "description": "Information about the current page." + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." } - } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] }, "examples": { "default": { "value": { - "attestations_subject_digests": [ - { - "sha256:abc": [ - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - }, - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - } - ] - } - ] + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "attestations" - }, - "x-github-breaking-changes": [ - { - "changeset": "remove_bundle", - "patch": { - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "attestations_subject_digests": { - "additionalProperties": { - "items": { - "properties": { - "bundle": null - } - } - } - } - } - } + }, + "200": { + "description": "Duplicate github_file resource already exists", + "content": { + "application/json": { + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "github_file", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" } } } } - }, - "version": "2026-03-10" - } - ] - } - }, - "/users/{username}/attestations/delete-request": { - "post": { - "summary": "Delete attestations in bulk", - "description": "Delete artifact attestations in bulk by either subject digests or unique ID.", - "tags": [ - "users" - ], - "operationId": "users/delete-attestations-bulk", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk" - }, - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "oneOf": [ - { - "properties": { - "subject_digests": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of subject digests associated with the artifact attestations to delete.", - "minItems": 1, - "maxItems": 1024 - } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "required": [ - "subject_digests" - ] - }, - { - "properties": { - "attestation_ids": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "List of unique IDs associated with the artifact attestations to delete.", - "minItems": 1, - "maxItems": 1024 - } + "documentation_url": { + "type": "string" }, - "required": [ - "attestation_ids" - ] - } - ], - "description": "The request body must include either `subject_digests` or `attestation_ids`, but not both." - }, - "examples": { - "by-subject-digests": { - "summary": "Delete by subject digests", - "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" - ] - } - }, - "by-attestation-ids": { - "summary": "Delete by attestation IDs", - "value": { - "attestation_ids": [ - 111, - 222 - ] + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } } } } - } - }, - "responses": { - "200": { - "description": "Response" }, "404": { "description": "Resource not found", @@ -774504,27 +787848,101 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "attestations" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" } } }, - "/users/{username}/attestations/digest/{subject_digest}": { - "delete": { - "summary": "Delete attestations by subject digest", - "description": "Delete an artifact attestation by subject digest.", + "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}": { + "get": { + "summary": "Get a resource for a Copilot Space for a user", + "description": "Gets a specific resource attached to a Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/delete-attestations-by-subject-digest", + "operationId": "copilot-spaces/get-resource-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest" + "url": "https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-a-copilot-space-for-a-user" }, "parameters": [ { @@ -774537,22 +787955,125 @@ } }, { - "name": "subject_digest", - "description": "Subject Digest", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { - "type": "string" - }, - "x-multi-segment": true + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { "200": { - "description": "Response" + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } }, - "204": { - "description": "Response" + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } }, "404": { "description": "Resource not found", @@ -774582,24 +788103,21 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "attestations" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/users/{username}/attestations/{attestation_id}": { - "delete": { - "summary": "Delete attestations by ID", - "description": "Delete an artifact attestation by unique ID that is associated with a repository owned by a user.", + }, + "put": { + "summary": "Set a resource for a Copilot Space for a user", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/delete-attestations-by-id", + "operationId": "copilot-spaces/update-resource-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/users/attestations#delete-attestations-by-id" + "url": "https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-a-copilot-space-for-a-user" }, "parameters": [ { @@ -774612,8 +788130,17 @@ } }, { - "name": "attestation_id", - "description": "Attestation ID", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", "in": "path", "required": true, "schema": { @@ -774621,12 +788148,108 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "Updated resource-specific metadata.", + "additionalProperties": true + } + } + }, + "examples": { + "default": { + "value": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + } + } + } + } + } + }, "responses": { "200": { - "description": "Response" - }, - "204": { - "description": "Response" + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" + } + } + } + } + } }, "403": { "description": "Forbidden", @@ -774679,56 +788302,101 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "attestations" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/users/{username}/attestations/{subject_digest}": { - "get": { - "summary": "List attestations", - "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + }, + "delete": { + "summary": "Delete a resource from a Copilot Space for a user", + "description": "Deletes a resource from a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/list-attestations", + "operationId": "copilot-spaces/delete-resource-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/users/attestations#list-attestations" + "url": "https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-a-copilot-space-for-a-user" }, "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, { "name": "username", "description": "The handle for the GitHub user account.", @@ -774739,226 +788407,54 @@ } }, { - "name": "subject_digest", - "description": "Subject Digest", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { - "type": "string" - }, - "x-multi-segment": true + "type": "integer" + } }, { - "name": "predicate_type", - "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", - "in": "query", - "required": false, + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "attestations": { - "type": "array", - "items": { - "type": "object", - "properties": { - "bundle": { - "type": "object", - "properties": { - "mediaType": { - "type": "string" - }, - "verificationMaterial": { - "type": "object", - "properties": {}, - "additionalProperties": true - }, - "dsseEnvelope": { - "type": "object", - "properties": {}, - "additionalProperties": true - } - }, - "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." - }, - "repository_id": { - "type": "integer" - }, - "bundle_url": { - "type": "string" - }, - "initiator": { - "type": "string" - } - } - } - } - } - }, - "examples": { - "default": { - "value": { - "attestations": [ - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - }, - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - } - ] + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "204": { - "description": "Response" - }, "404": { "description": "Resource not found", "content": { @@ -774987,38 +788483,10 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "attestations" - }, - "x-github-breaking-changes": [ - { - "changeset": "remove_bundle", - "patch": { - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "attestations": { - "items": { - "properties": { - "bundle": null - } - } - } - } - } - } - } - } - } - }, - "version": "2026-03-10" - } - ] + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" + } } }, "/users/{username}/docker/conflicts": { @@ -818869,7 +832337,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1053201,7 +1066669,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1056357,7 +1069825,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1059418,7 +1072886,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1062479,7 +1075947,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1065674,7 +1079142,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1068876,7 +1082344,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1074114,7 +1087582,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 2478f38fad..e34dac270e 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -73,10 +73,15 @@ tags: description: Interact with GitHub Teams. - name: users description: Interact with and view information about users and also current user. +- name: code-quality + description: Insights into reliability, maintainability, and efficiency of your + codebase. - name: codespaces description: Endpoints to manage Codespaces using the REST API. - name: copilot description: Endpoints to manage Copilot using the REST API. +- name: copilot-spaces + description: Endpoints to manage Copilot Spaces using the REST API. - name: security-advisories description: Manage security advisories. - name: interactions @@ -931,7 +936,7 @@ paths: - subscriptions_url - type - url - type: &316 + type: &320 type: string description: The type of credit the user is receiving. enum: @@ -1124,7 +1129,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &640 + - &644 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1715,7 +1720,7 @@ paths: schema: type: integer default: 30 - - &206 + - &210 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1724,7 +1729,7 @@ paths: required: false schema: type: string - - &207 + - &211 name: status description: Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries @@ -1744,7 +1749,7 @@ paths: application/json: schema: type: array - items: &208 + items: &212 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1840,7 +1845,7 @@ paths: - installation_id - repository_id examples: - default: &209 + default: &213 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1975,7 +1980,7 @@ paths: description: Response content: application/json: - schema: &210 + schema: &214 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -2110,7 +2115,7 @@ paths: - request - response examples: - default: &211 + default: &215 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2651,7 +2656,7 @@ paths: organization_copilot_agent_settings: type: string description: The level of permission to grant the access - token to view and manage Copilot coding agent settings + token to view and manage Copilot cloud agent settings for an organization. enum: - read @@ -9685,9 +9690,9 @@ paths: put: summary: Set the coding agent policy for an enterprise description: |- - Sets the policy for Copilot coding agent usage across an enterprise. + Sets the policy for Copilot cloud agent usage across an enterprise. - Enterprise owners can configure whether Copilot coding agent is enabled for all + Enterprise owners can configure whether Copilot cloud agent is enabled for all organizations, disabled for all organizations, configured by individual organization admins, or enabled for selected organizations only. @@ -9712,7 +9717,7 @@ paths: properties: policy_state: type: string - description: The policy state for Copilot coding agent in the enterprise. + description: The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`. enum: @@ -9738,7 +9743,7 @@ paths: post: summary: Add organizations to the enterprise coding agent policy description: |- - Enables Copilot coding agent for the specified organizations within the enterprise. + Enables Copilot cloud agent for the specified organizations within the enterprise. The enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before using this endpoint. Organizations can be specified by login or matched via custom properties. @@ -9757,7 +9762,7 @@ paths: parameters: - *38 requestBody: - description: The organizations to enable Copilot coding agent for + description: The organizations to enable Copilot cloud agent for required: true content: application/json: @@ -9767,7 +9772,7 @@ paths: organizations: type: array description: List of organization logins within the enterprise to - enable Copilot coding agent for. + enable Copilot cloud agent for. items: type: string custom_properties: @@ -9813,7 +9818,7 @@ paths: delete: summary: Remove organizations from the enterprise coding agent policy description: |- - Disables Copilot coding agent for the specified organizations within the enterprise. + Disables Copilot cloud agent for the specified organizations within the enterprise. The enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before using this endpoint. Organizations can be specified by login or matched via custom properties. @@ -9832,7 +9837,7 @@ paths: parameters: - *38 requestBody: - description: The organizations to disable Copilot coding agent for + description: The organizations to disable Copilot cloud agent for required: true content: application/json: @@ -9842,7 +9847,7 @@ paths: organizations: type: array description: List of organization logins within the enterprise to - disable Copilot coding agent for. + disable Copilot cloud agent for. items: type: string custom_properties: @@ -9905,7 +9910,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *38 - - &189 + - &193 name: classification in: query description: |- @@ -9914,7 +9919,7 @@ paths: Can be: `malware`, `general` schema: type: string - - &190 + - &194 name: state in: query description: |- @@ -9923,7 +9928,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &191 + - &195 name: severity in: query description: |- @@ -9932,7 +9937,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &192 + - &196 name: ecosystem in: query description: |- @@ -9941,14 +9946,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &193 + - &197 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &194 + - &198 name: epss_percentage in: query description: |- @@ -9960,7 +9965,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &475 + - &479 name: has in: query description: |- @@ -9974,7 +9979,7 @@ paths: type: string enum: - patch - - &195 + - &199 name: assignee in: query description: |- @@ -9983,7 +9988,7 @@ paths: Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. schema: type: string - - &196 + - &200 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -9993,7 +9998,7 @@ paths: enum: - development - runtime - - &197 + - &201 name: sort in: query description: |- @@ -10019,7 +10024,7 @@ paths: application/json: schema: type: array - items: &198 + items: &202 type: object description: A Dependabot alert. properties: @@ -10090,7 +10095,7 @@ paths: - transitive - inconclusive - - security_advisory: &476 + security_advisory: &480 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -10384,7 +10389,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &477 + auto_dismissed_at: &481 type: - string - 'null' @@ -10392,7 +10397,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissal_request: &478 + dismissal_request: &482 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -10455,7 +10460,7 @@ paths: - repository additionalProperties: false examples: - default: &199 + default: &203 value: - number: 2 state: dismissed @@ -10840,7 +10845,7 @@ paths: description: Response content: application/json: - schema: &200 + schema: &204 title: Dependabot Repository Access Details description: Information about repositories that Dependabot is able to access in an organization @@ -10866,7 +10871,7 @@ paths: - *65 additionalProperties: false examples: - default: &201 + default: &205 value: default_level: public accessible_repositories: @@ -12080,7 +12085,7 @@ paths: properties: action: type: string - discussion: &730 + discussion: &735 title: Discussion description: A Discussion in a repository. type: object @@ -12581,7 +12586,7 @@ paths: milestone: anyOf: - type: 'null' - - &268 + - &272 title: Milestone description: A collection of related issues and pull requests. @@ -12753,7 +12758,7 @@ paths: timeline_url: type: string format: uri - type: &232 + type: &236 title: Issue Type description: The type of issue. type: @@ -12864,7 +12869,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &651 + sub_issues_summary: &655 title: Sub-issues Summary type: object properties: @@ -12948,7 +12953,7 @@ paths: pin: anyOf: - type: 'null' - - &550 + - &554 title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. @@ -12975,7 +12980,7 @@ paths: - url - created_at - updated_at - issue_dependencies_summary: &652 + issue_dependencies_summary: &656 title: Issue Dependencies Summary type: object properties: @@ -12994,7 +12999,7 @@ paths: - total_blocking issue_field_values: type: array - items: &534 + items: &538 title: Issue Field Value description: A value assigned to an issue field type: object @@ -13818,7 +13823,7 @@ paths: type: string release: allOf: - - &582 + - &586 title: Release description: A release. type: object @@ -13900,7 +13905,7 @@ paths: author: *4 assets: type: array - items: &583 + items: &587 title: Release Asset description: Data related to a release. type: object @@ -14532,7 +14537,7 @@ paths: url: type: string format: uri - user: &658 + user: &662 title: Public User description: Public User type: object @@ -16436,7 +16441,7 @@ paths: - closed - all default: open - - &235 + - &239 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -16487,7 +16492,7 @@ paths: type: array items: *82 examples: - default: &236 + default: &240 value: - id: 1 node_id: MDU6SXNzdWUx @@ -17899,14 +17904,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &327 + - &331 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &328 + - &332 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -17968,7 +17973,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &331 + '301': &335 description: Moved permanently content: application/json: @@ -17990,7 +17995,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &558 + - &562 name: all description: If `true`, show notifications marked as read. in: query @@ -17998,7 +18003,7 @@ paths: schema: type: boolean default: false - - &559 + - &563 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -18008,7 +18013,7 @@ paths: type: boolean default: false - *87 - - &560 + - &564 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -18390,7 +18395,7 @@ paths: type: boolean examples: - false - security_and_analysis: &283 + security_and_analysis: &287 type: - object - 'null' @@ -18607,7 +18612,7 @@ paths: - url - subscription_url examples: - default: &561 + default: &565 value: - id: '1' repository: @@ -19911,7 +19916,7 @@ paths: required: false schema: type: string - - &707 + - &712 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -20057,7 +20062,7 @@ paths: parameters: - *74 - *116 - - &708 + - &713 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -20169,7 +20174,7 @@ paths: - *116 - *118 - *117 - - &709 + - &714 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -20177,7 +20182,7 @@ paths: schema: type: string - *119 - - &710 + - &715 name: sku description: The SKU to query for usage. in: query @@ -21184,7 +21189,7 @@ paths: type: integer repository_cache_usages: type: array - items: &338 + items: &342 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -22452,6 +22457,12 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the + name-based format. + type: boolean required: - include_claim_keys examples: @@ -22493,6 +22504,12 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the name-based + format. + type: boolean examples: default: *136 responses: @@ -22560,7 +22577,7 @@ paths: - all - local_only - selected - selected_actions_url: &344 + selected_actions_url: &348 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` @@ -22643,7 +22660,7 @@ paths: description: Response content: application/json: - schema: &348 + schema: &352 type: object properties: days: @@ -22685,7 +22702,7 @@ paths: required: true content: application/json: - schema: &349 + schema: &353 type: object properties: days: @@ -22742,7 +22759,7 @@ paths: required: - approval_policy examples: - default: &350 + default: &354 value: approval_policy: first_time_contributors '404': *6 @@ -22801,7 +22818,7 @@ paths: description: Response content: application/json: - schema: &351 + schema: &355 type: object required: - run_workflows_from_fork_pull_requests @@ -22855,7 +22872,7 @@ paths: required: true content: application/json: - schema: &352 + schema: &356 type: object required: - run_workflows_from_fork_pull_requests @@ -23490,7 +23507,7 @@ paths: description: Response content: application/json: - schema: &353 + schema: &357 type: object properties: default_workflow_permissions: &146 @@ -23541,7 +23558,7 @@ paths: required: false content: application/json: - schema: &354 + schema: &358 type: object properties: default_workflow_permissions: *146 @@ -24034,7 +24051,7 @@ paths: type: array items: *153 examples: - default: &188 + default: &192 value: total_count: 1 repositories: @@ -24681,7 +24698,7 @@ paths: application/json: schema: type: array - items: &355 + items: &359 title: Runner Application description: Runner Application type: object @@ -24706,7 +24723,7 @@ paths: - download_url - filename examples: - default: &356 + default: &360 value: - os: osx architecture: x64 @@ -24792,7 +24809,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &357 + '201': &361 description: Response content: application/json: @@ -24907,7 +24924,7 @@ paths: - token - expires_at examples: - default: &358 + default: &362 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -24946,7 +24963,7 @@ paths: application/json: schema: *157 examples: - default: &359 + default: &363 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -24980,7 +24997,7 @@ paths: application/json: schema: *155 examples: - default: &360 + default: &364 value: id: 23 name: MBP @@ -25206,7 +25223,7 @@ paths: - *74 - *154 responses: - '200': &361 + '200': &365 description: Response content: application/json: @@ -25263,7 +25280,7 @@ paths: parameters: - *74 - *154 - - &362 + - &366 name: name description: The name of a self-hosted runner's custom label. in: path @@ -25395,7 +25412,7 @@ paths: description: Response content: application/json: - schema: &374 + schema: &378 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -25430,7 +25447,7 @@ paths: - key_id - key examples: - default: &375 + default: &379 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -25843,7 +25860,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *74 - - &343 + - &347 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -27076,12 +27093,12 @@ paths: required: - subject_digests examples: - default: &689 + default: &693 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &690 + withPredicateType: &694 value: subject_digests: - sha256:abc123 @@ -27140,7 +27157,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &691 + default: &695 value: attestations_subject_digests: - sha256:abc: @@ -27506,7 +27523,7 @@ paths: initiator: type: string examples: - default: &388 + default: &392 value: attestations: - bundle: @@ -27796,7 +27813,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &187 + items: &191 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -27873,7 +27890,7 @@ paths: parent: anyOf: - type: 'null' - - &247 + - &251 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -28476,7 +28493,7 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *74 - - &412 + - &416 name: tool_name description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, @@ -28486,7 +28503,7 @@ paths: schema: &178 type: string description: The name of the tool used to generate the code scanning analysis. - - &413 + - &417 name: tool_guid description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in @@ -28510,7 +28527,7 @@ paths: be returned. in: query required: false - schema: &415 + schema: &419 type: string description: State of a code scanning alert. enum: @@ -28533,7 +28550,7 @@ paths: be returned. in: query required: false - schema: &416 + schema: &420 type: string description: Severity of a code scanning alert. enum: @@ -28567,7 +28584,7 @@ paths: updated_at: *173 url: *174 html_url: *175 - instances_url: &417 + instances_url: &421 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -28589,7 +28606,7 @@ paths: - type: 'null' - *4 dismissed_at: *177 - dismissed_reason: &418 + dismissed_reason: &422 type: - string - 'null' @@ -28600,14 +28617,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &419 + dismissed_comment: &423 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &420 + rule: &424 type: object properties: id: @@ -28668,7 +28685,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &421 + tool: &425 type: object properties: name: *178 @@ -28679,26 +28696,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *179 - most_recent_instance: &422 + most_recent_instance: &426 type: object properties: - ref: &414 + ref: &418 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &432 + analysis_key: &436 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - environment: &433 + environment: &437 type: string description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &434 + category: &438 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -28718,7 +28735,7 @@ paths: with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance. - location: &435 + location: &439 type: object description: Describe a region within a file for the alert. properties: @@ -28739,7 +28756,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: &436 + items: &440 type: - string - 'null' @@ -30040,7 +30057,7 @@ paths: type: integer codespaces: type: array - items: &237 + items: &241 type: object title: Codespace description: A codespace. @@ -30075,7 +30092,7 @@ paths: machine: anyOf: - type: 'null' - - &448 + - &452 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -30362,7 +30379,7 @@ paths: - pulls_url - recent_folders examples: - default: &238 + default: &242 value: total_count: 3 codespaces: @@ -31027,7 +31044,7 @@ paths: - updated_at - visibility examples: - default: &449 + default: &453 value: total_count: 2 secrets: @@ -31065,7 +31082,7 @@ paths: description: Response content: application/json: - schema: &450 + schema: &454 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -31100,7 +31117,7 @@ paths: - key_id - key examples: - default: &451 + default: &455 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -31132,7 +31149,7 @@ paths: application/json: schema: *186 examples: - default: &453 + default: &457 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -31414,6 +31431,1597 @@ paths: enabledForGitHubApps: false category: codespaces subcategory: organization-secrets + "/orgs/{org}/copilot-spaces": + get: + summary: List organization Copilot Spaces + description: |- + Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces. + + Only Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-organization-copilot-spaces + parameters: + - *74 + - name: per_page + description: The number of results per page (max 100). + in: query + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: before + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + in: query + schema: + type: string + - name: after + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. + in: query + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - spaces + properties: + spaces: + type: array + description: The list of Copilot Spaces on this page of results. + items: &187 + title: Space + description: A GitHub Copilot Space represents an interactive + AI workspace where users can ask questions and get assistance. + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the space. + examples: + - 42 + number: + type: integer + description: The number that identifies the space within + its owner. + examples: + - 1 + name: + type: string + description: The display name of the space. + examples: + - My Development Space + description: + type: + - string + - 'null' + description: A description of the space. + examples: + - A space for discussing React development patterns + general_instructions: + type: + - string + - 'null' + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Help with React development patterns and best practices + base_role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: |- + The base role that determines default permissions. + - `no_access`: No default access + - `reader`: Default read permissions + - `writer`: Default write permissions (organization spaces only) + - `admin`: Default admin permissions (organization spaces only) + examples: + - no_access + owner: + anyOf: + - *4 + - *72 + description: The user or organization that owns this space. + creator: *4 + created_at: + type: string + format: date-time + description: The date and time the space was created. + examples: + - '2023-01-01T00:00:00Z' + updated_at: + type: string + format: date-time + description: The date and time the space was last updated. + examples: + - '2023-01-01T12:00:00Z' + html_url: + type: string + format: uri + description: The HTML URL of the space. + examples: + - https://github.com/copilot/spaces/octo-org/5 + api_url: + type: string + format: uri + description: The API URL of the space. + examples: + - https://api.github.com/organizations/1/copilot-spaces/5 + resources_attributes: + type: array + description: Resources attached to the space. + items: + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the resource. + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + copilot_chat_attachment_id: + type: + - integer + - 'null' + format: int64 + description: The unique identifier of the chat attachment + for uploaded files or media content. + created_at: + type: string + format: date-time + description: The date and time the resource was created. + updated_at: + type: string + format: date-time + description: The date and time the resource was last + updated. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file + resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + copilot_chat_attachment_id: + type: integer + description: Chat attachment ID for uploaded files + or media. + media_type: + type: string + description: Media type for media content resources. + url: + type: string + description: URL for media content resources. + height: + type: integer + description: Height for media content resources. + width: + type: integer + description: Width for media content resources. + required: + - id + - number + - name + - base_role + - owner + - creator + - created_at + - updated_at + - html_url + - api_url + additionalProperties: false + examples: + default: + summary: Example response for listing organization copilot spaces + value: + spaces: + - id: 84 + number: 3 + name: Team Planning Space + description: Organization space for team planning and coordination + owner: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + gravatar_id: '' + name: octo-org + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: octo-org + html_url: https://github.com/octo-org + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + creator: + login: defunkt + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://github.com/images/error/defunkt_happy.gif + gravatar_id: '' + url: https://api.github.com/users/defunkt + html_url: https://github.com/defunkt + followers_url: https://api.github.com/users/defunkt/followers + following_url: https://api.github.com/users/defunkt/following{/other_user} + gists_url: https://api.github.com/users/defunkt/gists{/gist_id} + starred_url: https://api.github.com/users/defunkt/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/defunkt/subscriptions + organizations_url: https://api.github.com/users/defunkt/orgs + repos_url: https://api.github.com/users/defunkt/repos + events_url: https://api.github.com/users/defunkt/events{/privacy} + received_events_url: https://api.github.com/users/defunkt/received_events + type: User + site_admin: true + created_at: '2023-02-15T08:30:00Z' + updated_at: '2023-02-15T14:45:00Z' + html_url: https://github.com/copilot/spaces/octo-org/3 + api_url: https://api.github.com/organizations/1/copilot-spaces/3 + - id: 85 + number: 4 + name: Development Resources + description: Shared development documentation and resources + owner: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + gravatar_id: '' + name: octo-org + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: octo-org + html_url: https://github.com/octo-org + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + creator: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-16T10:15:00Z' + updated_at: '2023-02-16T16:30:00Z' + html_url: https://github.com/copilot/spaces/octo-org/4 + api_url: https://api.github.com/organizations/1/copilot-spaces/4 + headers: + Link: *66 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + post: + summary: Create an organization Copilot Space + description: |- + Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization. + + Organization members with appropriate permissions can create Copilot Spaces to be shared within their organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-an-organization-copilot-space + parameters: + - *74 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - Team Planning Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Organization space for team planning and coordination + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Help the team with planning and coordination tasks + base_role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: |- + The base role that determines default permissions for organization members. + - `no_access`: No default access (default) + - `reader`: Organization members can read the space + - `writer`: Organization members can read and edit the space + - `admin`: Organization members have full admin access to the space + default: no_access + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + required: + - name + examples: + default: + value: + name: Team Planning Space + description: Organization space for team planning and coordination + general_instructions: Help the team with planning and coordination + tasks + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 123456 + file_path: docs/planning.md + - resource_type: free_text + metadata: + name: Team Guidelines + text: Our team follows agile methodology and holds daily standups + responses: + '201': + description: Response + content: + application/json: + schema: *187 + examples: + default: &188 + summary: Example response for an organization copilot space + value: + id: 84 + number: 3 + name: Team Planning Space + description: Organization space for team planning and coordination + general_instructions: Help the team with agile planning, sprint + coordination, and project management best practices + owner: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + gravatar_id: '' + name: octo-org + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: octo-org + html_url: https://github.com/octo-org + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + creator: + login: defunkt + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://github.com/images/error/defunkt_happy.gif + gravatar_id: '' + url: https://api.github.com/users/defunkt + html_url: https://github.com/defunkt + followers_url: https://api.github.com/users/defunkt/followers + following_url: https://api.github.com/users/defunkt/following{/other_user} + gists_url: https://api.github.com/users/defunkt/gists{/gist_id} + starred_url: https://api.github.com/users/defunkt/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/defunkt/subscriptions + organizations_url: https://api.github.com/users/defunkt/orgs + repos_url: https://api.github.com/users/defunkt/repos + events_url: https://api.github.com/users/defunkt/events{/privacy} + received_events_url: https://api.github.com/users/defunkt/received_events + type: User + site_admin: true + created_at: '2023-02-15T08:30:00Z' + updated_at: '2023-02-15T14:45:00Z' + html_url: https://github.com/copilot/spaces/octo-org/3 + api_url: https://api.github.com/organizations/1/copilot-spaces/3 + base_role: no_access + resources_attributes: + - id: 123 + resource_type: github_file + metadata: + repository_id: 456 + file_path: docs/planning.md + - id: 124 + resource_type: free_text + metadata: + name: Team Guidelines + text: Our team follows agile methodology + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + "/orgs/{org}/copilot-spaces/{space_number}": + get: + summary: Get an organization Copilot Space + description: |- + Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space. + + Internal Spaces require the authenticated user to be a member of the organization or have been granted read permissions. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *187 + examples: + default: *188 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + put: + summary: Set an organization Copilot Space + description: |- + Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization. + + Organization members with appropriate permissions can update Copilot Spaces owned by their organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - Updated Team Planning Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Updated organization space for team planning and coordination + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Updated instructions to help the team with planning and coordination + tasks + base_role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: |- + The base role that determines default permissions for organization members. Changing this field requires admin permissions. + - `no_access`: No default access (default) + - `reader`: Organization members can read the space + - `writer`: Organization members can read and edit the space + - `admin`: Organization members have full admin access to the space + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + examples: + default: + value: + name: Updated Team Planning Space + description: Updated organization space for team planning and coordination + general_instructions: Updated instructions to help the team with + planning and coordination tasks + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 123456 + file_path: docs/updated-planning.md + - id: 789 + _destroy: true + - id: 456 + resource_type: free_text + metadata: + name: Updated Team Guidelines + text: Our updated team follows agile methodology and holds daily + standups + responses: + '200': + description: Response + content: + application/json: + schema: *187 + examples: + default: *188 + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + delete: + summary: Delete an organization Copilot Space + description: |- + Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization. + + **Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations. + + Organization members with appropriate permissions can delete Copilot Spaces owned by their organization. + + OAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '204': + description: The Copilot Space has been successfully deleted. + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + "/orgs/{org}/copilot-spaces/{space_number}/collaborators": + get: + summary: List collaborators for an organization Copilot Space + description: |- + Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators. + + Each collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list. + + **Note:** Team collaborators listed here are teams that are defined in the organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-collaborators-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - collaborators + properties: + collaborators: + type: array + description: The list of collaborators for this Copilot Space. + items: &189 + title: Copilot Space Collaborator + description: A collaborator (user or team) of a Copilot Space + type: object + anyOf: + - allOf: + - *4 + - type: object + properties: + actor_type: + type: string + enum: + - User + description: The collaborator actor type. + role: + type: string + enum: + - reader + - writer + - admin + description: The role granted to the collaborator + required: + - actor_type + - role + - type: object + properties: + actor_type: + type: string + enum: + - Team + description: The collaborator actor type. + role: + type: string + enum: + - reader + - writer + - admin + description: The role granted to the collaborator + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + type: + type: string + enum: + - Team + description: + type: + - string + - 'null' + privacy: + type: string + notification_setting: + type: string + url: + type: string + format: uri + html_url: + type: string + format: uri + members_url: + type: string + repositories_url: + type: string + format: uri + organization_id: + type: integer + parent: + type: + - 'null' + required: + - actor_type + - role + - id + - node_id + - name + - slug + - type + examples: + default: + value: + collaborators: + - actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + - actor_type: Team + role: reader + id: 67890 + node_id: MDQ6VGVhbTY3ODkw + url: https://api.github.com/teams/67890 + html_url: https://github.com/orgs/octo-org/teams/developers + name: Developers + slug: developers + description: Team of developers + privacy: closed + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/67890/members{/member} + repositories_url: https://api.github.com/teams/67890/repos + parent: + created_at: '2017-07-14T16:53:42Z' + updated_at: '2017-08-17T12:37:15Z' + organization: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + post: + summary: Add a collaborator to an organization Copilot Space + description: |- + Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. + + **Note:** When adding users as collaborators, they must already be members of the organization. + When adding teams as collaborators, they must be defined in the organization. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/add-collaborator-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - actor_type + - actor_identifier + - role + properties: + actor_type: + type: string + enum: + - User + - Team + description: The type of actor (user or team). + actor_identifier: + type: string + description: The username (for users) or team slug (for teams). + The numeric ID of a user or team is also accepted. + role: + type: string + enum: + - reader + - writer + - admin + description: The role to grant to the collaborator. + examples: + user: + value: + actor_type: User + actor_identifier: octocat + role: writer + team: + value: + actor_type: Team + actor_identifier: developers + role: reader + responses: + '201': + description: Response + content: + application/json: + schema: *189 + examples: + user: + value: + actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + team: + value: + actor_type: Team + role: reader + id: 67890 + node_id: MDQ6VGVhbTY3ODkw + url: https://api.github.com/teams/67890 + html_url: https://github.com/orgs/octo-org/teams/developers + name: Developers + slug: developers + type: Team + description: Team of developers + privacy: closed + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/67890/members{/member} + repositories_url: https://api.github.com/teams/67890/repos + parent: + organization_id: 1 + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": + put: + summary: Set a collaborator role for an organization Copilot Space + description: |- + Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-collaborator-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (user or team). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username (for users) or team slug (for teams). The numeric + ID of a user or team is also accepted. + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - role + properties: + role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: The new role to grant to the collaborator. Use `no_access` + to remove the collaborator. + examples: + default: + value: + role: admin + responses: + '200': + description: Response + content: + application/json: + schema: *189 + examples: + user: + value: + actor_type: User + role: admin + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + team: + value: + actor_type: Team + role: admin + id: 67890 + node_id: MDQ6VGVhbTY3ODkw + url: https://api.github.com/teams/67890 + html_url: https://github.com/orgs/octo-org/teams/developers + name: Developers + slug: developers + type: Team + description: Team of developers + privacy: closed + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/67890/members{/member} + repositories_url: https://api.github.com/teams/67890/repos + parent: + organization_id: 1 + '204': + description: Response when `role` is `no_access` and the collaborator was + removed. + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + delete: + summary: Remove a collaborator from an organization Copilot Space + description: |- + Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/remove-collaborator-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (user or team). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username (for users) or team slug (for teams). The numeric + ID of a user or team is also accepted. + in: path + required: true + schema: + type: string + responses: + '204': + description: Response + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + "/orgs/{org}/copilot-spaces/{space_number}/resources": + get: + summary: List resources for an organization Copilot Space + description: |- + Lists all resources attached to a specific Copilot Space owned by an organization. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-resources-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - resources + properties: + resources: + type: array + description: The list of resources attached to this Copilot Space. + items: &190 + title: Copilot Space Resource + description: A resource attached to a Copilot Space. + type: object + properties: + id: + type: integer + description: The unique identifier of the resource. + resource_type: + type: string + description: The type of the resource. + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + copilot_chat_attachment_id: + type: + - integer + - 'null' + description: The ID of the associated chat attachment, if + any. + metadata: + type: object + description: Resource-specific metadata. The keys and values + depend on the resource type. + additionalProperties: true + created_at: + type: string + format: date-time + description: The date and time the resource was created. + updated_at: + type: string + format: date-time + description: The date and time the resource was last updated. + required: + - id + - resource_type + - metadata + - created_at + - updated_at + examples: + default: + value: + resources: + - id: 1 + resource_type: repository + copilot_chat_attachment_id: + metadata: + repository_id: 42 + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + - id: 2 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + post: + summary: Create a resource for an organization Copilot Space + description: |- + Creates a new resource in a specific Copilot Space owned by an organization. + The authenticated user must have write permissions on the space. + + The following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`. + The `uploaded_text_file` and `media_content` types are not supported via this endpoint. + + For `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - resource_type + - metadata + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + description: The type of resource to create. + metadata: + type: object + description: Resource-specific metadata. + additionalProperties: true + examples: + free_text: + value: + resource_type: free_text + metadata: + name: notes.txt + text: Some helpful notes + repository: + value: + resource_type: repository + metadata: + repository_id: 42 + github_file: + value: + resource_type: github_file + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + responses: + '201': + description: Resource created + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '200': + description: Duplicate github_file resource already exists + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: github_file + copilot_chat_attachment_id: + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": + get: + summary: Get a resource for an organization Copilot Space + description: |- + Gets a specific resource attached to a Copilot Space owned by an organization. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + put: + summary: Set a resource for an organization Copilot Space + description: |- + Updates the metadata of a resource in a specific Copilot Space owned by an organization. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + description: Updated resource-specific metadata. + additionalProperties: true + examples: + default: + value: + metadata: + name: updated-notes.txt + text: Updated content + responses: + '200': + description: Response + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: updated-notes.txt + text: Updated content + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T12:00:00Z' + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + delete: + summary: Delete a resource from an organization Copilot Space + description: |- + Deletes a resource from a specific Copilot Space owned by an organization. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-an-organization-copilot-space + parameters: + - *74 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources "/orgs/{org}/copilot/billing": get: summary: Get Copilot seat information and settings for an organization @@ -31599,7 +33207,7 @@ paths: currently being billed. seats: type: array - items: &240 + items: &244 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -31617,7 +33225,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *187 + - *191 - *67 type: - 'null' @@ -32076,15 +33684,15 @@ paths: subcategory: copilot-user-management "/orgs/{org}/copilot/coding-agent/permissions": get: - summary: Get Copilot coding agent permissions for an organization + summary: Get Copilot cloud agent permissions for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Gets information about which repositories in an organization have been enabled - or disabled for the Copilot coding agent. + or disabled for the Copilot cloud agent. - Organization owners can configure whether Copilot coding agent is enabled for + Organization owners can configure whether Copilot cloud agent is enabled for all repositories, selected repositories, or no repositories owned by organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -32093,7 +33701,7 @@ paths: operationId: copilot/get-copilot-coding-agent-permissions-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-cloud-agent-permissions-for-an-organization parameters: - *74 responses: @@ -32107,7 +33715,7 @@ paths: enabled_repositories: type: string description: The policy for which repositories can use Copilot - coding agent. Can be one of `all`, `selected`, or `none`. + cloud agent. Can be one of `all`, `selected`, or `none`. enum: - all - selected @@ -32142,14 +33750,14 @@ paths: category: copilot subcategory: copilot-coding-agent-management put: - summary: Set Copilot coding agent permissions for an organization + summary: Set Copilot cloud agent permissions for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. - Sets the policy for which repositories in an organization can use Copilot coding agent. + Sets the policy for which repositories in an organization can use Copilot cloud agent. - Organization owners can configure whether Copilot coding agent is enabled for + Organization owners can configure whether Copilot cloud agent is enabled for all repositories, selected repositories, or no repositories owned by the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -32158,7 +33766,7 @@ paths: operationId: copilot/set-copilot-coding-agent-permissions-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-cloud-agent-permissions-for-an-organization parameters: - *74 requestBody: @@ -32170,7 +33778,7 @@ paths: properties: enabled_repositories: type: string - description: The policy for which repositories can use Copilot coding + description: The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`. enum: - all @@ -32197,12 +33805,12 @@ paths: subcategory: copilot-coding-agent-management "/orgs/{org}/copilot/coding-agent/permissions/repositories": get: - summary: List repositories enabled for Copilot coding agent in an organization + summary: List repositories enabled for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists the selected repositories that are enabled for Copilot coding agent in an organization. + Lists the selected repositories that are enabled for Copilot cloud agent in an organization. Organization owners can use this endpoint when the coding agent repository policy is set to `selected` to see which repositories have been enabled. @@ -32213,7 +33821,7 @@ paths: operationId: copilot/list-copilot-coding-agent-selected-repositories-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-cloud-agent-in-an-organization parameters: - *74 - *17 @@ -32235,7 +33843,7 @@ paths: - total_count - repositories examples: - default: *188 + default: *192 '500': *53 '401': *23 '403': *27 @@ -32247,13 +33855,13 @@ paths: category: copilot subcategory: copilot-coding-agent-management put: - summary: Set selected repositories for Copilot coding agent in an organization + summary: Set selected repositories for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. - Replaces the list of selected repositories that are enabled for Copilot coding - agent in an organization. This method can only be called when the coding agent + Replaces the list of selected repositories that are enabled for Copilot cloud + agent in an organization. This method can only be called when the cloud agent repository policy is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -32262,7 +33870,7 @@ paths: operationId: copilot/set-copilot-coding-agent-selected-repositories-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-cloud-agent-in-an-organization parameters: - *74 requestBody: @@ -32273,7 +33881,7 @@ paths: type: object properties: selected_repository_ids: - description: List of repository IDs to enable for Copilot coding + description: List of repository IDs to enable for Copilot cloud agent. type: array items: @@ -32303,14 +33911,14 @@ paths: subcategory: copilot-coding-agent-management "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}": put: - summary: Enable a repository for Copilot coding agent in an organization + summary: Enable a repository for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Adds a repository to the list of selected repositories enabled for Copilot - coding agent in an organization. This method can only be called when the - coding agent repository policy is set to `selected`. + cloud agent in an organization. This method can only be called when the + cloud agent repository policy is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -32318,7 +33926,7 @@ paths: operationId: copilot/enable-copilot-coding-agent-for-repository-in-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-cloud-agent-in-an-organization parameters: - *74 - *142 @@ -32337,14 +33945,14 @@ paths: category: copilot subcategory: copilot-coding-agent-management delete: - summary: Disable a repository for Copilot coding agent in an organization + summary: Disable a repository for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Removes a repository from the list of selected repositories enabled for Copilot - coding agent in an organization. This method can only be called when the - coding agent repository policy is set to `selected`. + cloud agent in an organization. This method can only be called when the + cloud agent repository policy is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint. tags: @@ -32352,7 +33960,7 @@ paths: operationId: copilot/disable-copilot-coding-agent-for-repository-in-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-cloud-agent-in-an-organization parameters: - *74 - *142 @@ -32570,7 +34178,7 @@ paths: application/json: schema: type: array - items: &320 + items: &324 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -32885,7 +34493,7 @@ paths: - date additionalProperties: true examples: - default: &321 + default: &325 value: - date: '2024-06-24' total_active_users: 24 @@ -32987,7 +34595,7 @@ paths: '500': *53 '403': *27 '404': *6 - '422': &322 + '422': &326 description: Copilot Usage Metrics API setting is disabled at the organization or enterprise level. content: @@ -33167,12 +34775,12 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *74 - - *189 - - *190 - - *191 - - *192 - *193 - *194 + - *195 + - *196 + - *197 + - *198 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -33202,7 +34810,7 @@ paths: enum: - patch - deployment - - *195 + - *199 - name: runtime_risk in: query description: |- @@ -33211,8 +34819,8 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *196 - - *197 + - *200 + - *201 - *60 - *45 - *46 @@ -33224,9 +34832,9 @@ paths: application/json: schema: type: array - items: *198 + items: *202 examples: - default: *199 + default: *203 '304': *35 '400': *14 '403': *27 @@ -33275,9 +34883,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *204 examples: - default: *201 + default: *205 '403': *27 '404': *6 x-github: @@ -33441,7 +35049,7 @@ paths: type: integer secrets: type: array - items: &202 + items: &206 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -33520,7 +35128,7 @@ paths: description: Response content: application/json: - schema: &481 + schema: &485 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -33539,7 +35147,7 @@ paths: - key_id - key examples: - default: &482 + default: &486 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -33569,7 +35177,7 @@ paths: description: Response content: application/json: - schema: *202 + schema: *206 examples: default: value: @@ -33876,7 +35484,7 @@ paths: application/json: schema: type: array - items: &249 + items: &253 title: Package description: A software package type: object @@ -33947,7 +35555,7 @@ paths: - created_at - updated_at examples: - default: &250 + default: &254 value: - id: 197 name: hello_docker @@ -34117,7 +35725,7 @@ paths: application/json: schema: type: array - items: &226 + items: &230 title: Organization Invitation description: Organization Invitation type: object @@ -34171,7 +35779,7 @@ paths: - invitation_teams_url - node_id examples: - default: &227 + default: &231 value: - id: 1 login: monalisa @@ -34238,7 +35846,7 @@ paths: application/json: schema: type: array - items: &203 + items: &207 title: Org Hook description: Org Hook type: object @@ -34423,9 +36031,9 @@ paths: description: Response content: application/json: - schema: *203 + schema: *207 examples: - default: &204 + default: &208 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -34473,7 +36081,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - *74 - - &205 + - &209 name: hook_id description: The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. @@ -34486,9 +36094,9 @@ paths: description: Response content: application/json: - schema: *203 + schema: *207 examples: - default: *204 + default: *208 '404': *6 x-github: githubCloudOnly: false @@ -34516,7 +36124,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - *74 - - *205 + - *209 requestBody: required: false content: @@ -34562,7 +36170,7 @@ paths: description: Response content: application/json: - schema: *203 + schema: *207 examples: default: value: @@ -34604,7 +36212,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - *74 - - *205 + - *209 responses: '204': description: Response @@ -34632,7 +36240,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *74 - - *205 + - *209 responses: '200': description: Response @@ -34663,7 +36271,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *74 - - *205 + - *209 requestBody: required: false content: @@ -34714,10 +36322,10 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *74 - - *205 + - *209 - *17 - - *206 - - *207 + - *210 + - *211 responses: '200': description: Response @@ -34725,9 +36333,9 @@ paths: application/json: schema: type: array - items: *208 + items: *212 examples: - default: *209 + default: *213 '400': *14 '422': *15 x-github: @@ -34753,16 +36361,16 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *74 - - *205 + - *209 - *16 responses: '200': description: Response content: application/json: - schema: *210 + schema: *214 examples: - default: *211 + default: *215 '400': *14 '422': *15 x-github: @@ -34788,7 +36396,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *74 - - *205 + - *209 - *16 responses: '202': *37 @@ -34818,7 +36426,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - *74 - - *205 + - *209 responses: '204': description: Response @@ -34841,7 +36449,7 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - *74 - - &216 + - &220 name: actor_type in: path description: The type of the actor @@ -34854,14 +36462,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &217 + - &221 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &212 + - &216 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -34869,7 +36477,7 @@ paths: required: true schema: type: string - - &213 + - &217 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -34964,12 +36572,12 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - *74 - - *212 - - *213 + - *216 + - *217 - *19 - *17 - *60 - - &222 + - &226 name: sort description: The property to sort the results by. in: query @@ -35048,14 +36656,14 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - *74 - - *212 - - *213 + - *216 + - *217 responses: '200': description: Response content: application/json: - schema: &214 + schema: &218 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -35071,7 +36679,7 @@ paths: type: integer format: int64 examples: - default: &215 + default: &219 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -35092,23 +36700,23 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - *74 - - &218 + - &222 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *212 - - *213 + - *216 + - *217 responses: '200': description: Response content: application/json: - schema: *214 + schema: *218 examples: - default: *215 + default: *219 x-github: enabledForGitHubApps: true category: orgs @@ -35127,18 +36735,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - *74 - - *212 - - *213 - *216 - *217 + - *220 + - *221 responses: '200': description: Response content: application/json: - schema: *214 + schema: *218 examples: - default: *215 + default: *219 x-github: enabledForGitHubApps: true category: orgs @@ -35156,9 +36764,9 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - *74 - - *212 - - *213 - - &219 + - *216 + - *217 + - &223 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -35171,7 +36779,7 @@ paths: description: Response content: application/json: - schema: &220 + schema: &224 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -35187,7 +36795,7 @@ paths: type: integer format: int64 examples: - default: &221 + default: &225 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -35224,18 +36832,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - *74 - - *218 - - *212 - - *213 - - *219 + - *222 + - *216 + - *217 + - *223 responses: '200': description: Response content: application/json: - schema: *220 + schema: *224 examples: - default: *221 + default: *225 x-github: enabledForGitHubApps: true category: orgs @@ -35253,19 +36861,19 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - *74 + - *220 + - *221 - *216 - *217 - - *212 - - *213 - - *219 + - *223 responses: '200': description: Response content: application/json: - schema: *220 + schema: *224 examples: - default: *221 + default: *225 x-github: enabledForGitHubApps: true category: orgs @@ -35283,13 +36891,13 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - *74 - - *218 - - *212 - - *213 + - *222 + - *216 + - *217 - *19 - *17 - *60 - - *222 + - *226 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -35373,7 +36981,7 @@ paths: application/json: schema: *20 examples: - default: &521 + default: &525 value: id: 1 account: @@ -35539,12 +37147,12 @@ paths: application/json: schema: anyOf: - - &224 + - &228 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &223 + limit: &227 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -35572,7 +37180,7 @@ paths: properties: {} additionalProperties: false examples: - default: &225 + default: &229 value: limit: collaborators_only origin: organization @@ -35601,13 +37209,13 @@ paths: required: true content: application/json: - schema: &522 + schema: &526 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *223 + limit: *227 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -35632,9 +37240,9 @@ paths: description: Response content: application/json: - schema: *224 + schema: *228 examples: - default: *225 + default: *229 '422': *15 x-github: githubCloudOnly: false @@ -35710,9 +37318,9 @@ paths: application/json: schema: type: array - items: *226 + items: *230 examples: - default: *227 + default: *231 headers: Link: *66 '404': *6 @@ -35789,7 +37397,7 @@ paths: description: Response content: application/json: - schema: *226 + schema: *230 examples: default: value: @@ -35844,7 +37452,7 @@ paths: url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - *74 - - &228 + - &232 name: invitation_id description: The unique identifier of the invitation. in: path @@ -35875,7 +37483,7 @@ paths: url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - *74 - - *228 + - *232 - *17 - *19 responses: @@ -35885,9 +37493,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - default: &248 + default: &252 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -35930,7 +37538,7 @@ paths: application/json: schema: type: array - items: &229 + items: &233 title: Issue Field description: A custom attribute defined at the organization level for attaching structured data to issues. @@ -36173,9 +37781,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *233 examples: - default: &230 + default: &234 value: id: 512 node_id: IF_kwDNAd3NAZr @@ -36231,7 +37839,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-fields#update-issue-field-for-an-organization parameters: - *74 - - &231 + - &235 name: issue_field_id description: The unique identifier of the issue field. in: path @@ -36341,9 +37949,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *233 examples: - default: *230 + default: *234 '404': *6 '422': *7 x-github: @@ -36368,7 +37976,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-fields#delete-issue-field-for-an-organization parameters: - *74 - - *231 + - *235 responses: '204': *59 '404': *6 @@ -36398,7 +38006,7 @@ paths: application/json: schema: type: array - items: *232 + items: *236 examples: default: value: @@ -36486,9 +38094,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *236 examples: - default: &233 + default: &237 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -36521,7 +38129,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *74 - - &234 + - &238 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -36577,9 +38185,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *236 examples: - default: *233 + default: *237 '404': *6 '422': *7 x-github: @@ -36604,7 +38212,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *74 - - *234 + - *238 responses: '204': description: Response @@ -36667,7 +38275,7 @@ paths: - closed - all default: open - - *235 + - *239 - name: type description: Can be the name of an issue type. in: query @@ -36698,7 +38306,7 @@ paths: type: array items: *82 examples: - default: *236 + default: *240 headers: Link: *66 '404': *6 @@ -36863,9 +38471,9 @@ paths: type: integer codespaces: type: array - items: *237 + items: *241 examples: - default: *238 + default: *242 '304': *35 '500': *53 '401': *23 @@ -36892,7 +38500,7 @@ paths: parameters: - *74 - *70 - - &239 + - &243 name: codespace_name in: path required: true @@ -36927,15 +38535,15 @@ paths: parameters: - *74 - *70 - - *239 + - *243 responses: '200': description: Response content: application/json: - schema: *237 + schema: *241 examples: - default: &447 + default: &451 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -37115,7 +38723,7 @@ paths: description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *240 + schema: *244 examples: default: value: @@ -37191,7 +38799,7 @@ paths: description: Response content: application/json: - schema: &241 + schema: &245 title: Org Membership description: Org Membership type: object @@ -37260,7 +38868,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &242 + response-if-user-has-an-active-admin-membership-with-organization: &246 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -37361,9 +38969,9 @@ paths: description: Response content: application/json: - schema: *241 + schema: *245 examples: - response-if-user-already-had-membership-with-organization: *242 + response-if-user-already-had-membership-with-organization: *246 '422': *15 '403': *27 x-github: @@ -37441,7 +39049,7 @@ paths: application/json: schema: type: array - items: &243 + items: &247 title: Migration description: A migration. type: object @@ -37790,7 +39398,7 @@ paths: description: Response content: application/json: - schema: *243 + schema: *247 examples: default: value: @@ -37969,7 +39577,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - *74 - - &244 + - &248 name: migration_id description: The unique identifier of the migration. in: path @@ -37997,7 +39605,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *243 + schema: *247 examples: default: value: @@ -38167,7 +39775,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - *74 - - *244 + - *248 responses: '302': description: Response @@ -38189,7 +39797,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - *74 - - *244 + - *248 responses: '204': description: Response @@ -38213,8 +39821,8 @@ paths: url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - *74 - - *244 - - &672 + - *248 + - &676 name: repo_name description: repo_name parameter in: path @@ -38242,7 +39850,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - *74 - - *244 + - *248 - *17 - *19 responses: @@ -38254,7 +39862,7 @@ paths: type: array items: *153 examples: - default: &255 + default: &259 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -38427,7 +40035,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &246 + items: &250 title: Organization Role description: Organization roles type: object @@ -38604,7 +40212,7 @@ paths: parameters: - *74 - *76 - - &245 + - &249 name: role_id description: The unique identifier of the role. in: path @@ -38641,7 +40249,7 @@ paths: parameters: - *74 - *76 - - *245 + - *249 responses: '204': description: Response @@ -38694,7 +40302,7 @@ paths: parameters: - *74 - *70 - - *245 + - *249 responses: '204': description: Response @@ -38726,7 +40334,7 @@ paths: parameters: - *74 - *70 - - *245 + - *249 responses: '204': description: Response @@ -38755,13 +40363,13 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - *74 - - *245 + - *249 responses: '200': description: Response content: application/json: - schema: *246 + schema: *250 examples: default: value: @@ -38812,7 +40420,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - *74 - - *245 + - *249 - *17 - *19 responses: @@ -38891,7 +40499,7 @@ paths: parent: anyOf: - type: 'null' - - *247 + - *251 type: description: The ownership type of the team type: string @@ -38924,7 +40532,7 @@ paths: - type - parent examples: - default: *248 + default: *252 headers: Link: *66 '404': @@ -38954,7 +40562,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - *74 - - *245 + - *249 - *17 - *19 responses: @@ -38983,7 +40591,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *247 + items: *251 name: type: - string @@ -39293,7 +40901,7 @@ paths: - nuget - container - *74 - - &673 + - &677 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -39329,12 +40937,12 @@ paths: application/json: schema: type: array - items: *249 + items: *253 examples: - default: *250 + default: *254 '403': *27 '401': *23 - '400': &675 + '400': &679 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -39356,7 +40964,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &251 + - &255 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -39374,7 +40982,7 @@ paths: - docker - nuget - container - - &252 + - &256 name: package_name description: The name of the package. in: path @@ -39387,7 +40995,7 @@ paths: description: Response content: application/json: - schema: *249 + schema: *253 examples: default: value: @@ -39439,8 +41047,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *251 - - *252 + - *255 + - *256 - *74 responses: '204': @@ -39473,8 +41081,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *251 - - *252 + - *255 + - *256 - *74 - name: token description: package token @@ -39507,8 +41115,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *251 - - *252 + - *255 + - *256 - *74 - *19 - *17 @@ -39529,7 +41137,7 @@ paths: application/json: schema: type: array - items: &253 + items: &257 title: Package Version description: A version of a software package type: object @@ -39664,10 +41272,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *251 - - *252 + - *255 + - *256 - *74 - - &254 + - &258 name: package_version_id description: Unique identifier of the package version. in: path @@ -39679,7 +41287,7 @@ paths: description: Response content: application/json: - schema: *253 + schema: *257 examples: default: value: @@ -39715,10 +41323,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *251 - - *252 + - *255 + - *256 - *74 - - *254 + - *258 responses: '204': description: Response @@ -39750,10 +41358,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *251 - - *252 + - *255 + - *256 - *74 - - *254 + - *258 responses: '204': description: Response @@ -39783,7 +41391,7 @@ paths: - *74 - *17 - *19 - - &256 + - &260 name: sort description: The property by which to sort the results. in: query @@ -39794,7 +41402,7 @@ paths: - created_at default: created_at - *60 - - &257 + - &261 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -39806,7 +41414,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &258 + - &262 name: repository description: The name of the repository to use to filter the results. in: query @@ -39815,7 +41423,7 @@ paths: type: string examples: - Hello-World - - &259 + - &263 name: permission description: The permission to use to filter the results. in: query @@ -39824,7 +41432,7 @@ paths: type: string examples: - issues_read - - &260 + - &264 name: last_used_before description: 'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -39834,7 +41442,7 @@ paths: schema: type: string format: date-time - - &261 + - &265 name: last_used_after description: 'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -39844,7 +41452,7 @@ paths: schema: type: string format: date-time - - &262 + - &266 name: token_id description: The ID of the token in: query @@ -40163,7 +41771,7 @@ paths: type: array items: *153 examples: - default: *255 + default: *259 headers: Link: *66 x-github: @@ -40189,14 +41797,14 @@ paths: - *74 - *17 - *19 - - *256 - - *60 - - *257 - - *258 - - *259 - *260 + - *60 - *261 - *262 + - *263 + - *264 + - *265 + - *266 responses: '500': *53 '422': *15 @@ -40480,7 +42088,7 @@ paths: type: array items: *153 examples: - default: *255 + default: *259 headers: Link: *66 x-github: @@ -40522,7 +42130,7 @@ paths: type: integer configurations: type: array - items: &263 + items: &267 title: Organization private registry description: Private registry configuration for an organization type: object @@ -40999,7 +42607,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &264 + org-private-registry-with-selected-visibility: &268 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -41097,9 +42705,9 @@ paths: description: The specified private registry configuration for the organization content: application/json: - schema: *263 + schema: *267 examples: - default: *264 + default: *268 '404': *6 x-github: githubCloudOnly: false @@ -41340,7 +42948,7 @@ paths: application/json: schema: type: array - items: &265 + items: &269 title: Projects v2 Project description: A projects v2 project type: object @@ -41414,7 +43022,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &758 + - &763 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -41499,7 +43107,7 @@ paths: - deleted_at - deleted_by examples: - default: &266 + default: &270 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -41602,7 +43210,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-organization parameters: - - &267 + - &271 name: project_number description: The project's number. in: path @@ -41615,9 +43223,9 @@ paths: description: Response content: application/json: - schema: *265 + schema: *269 examples: - default: *266 + default: *270 headers: Link: *66 '304': *35 @@ -41640,7 +43248,7 @@ paths: url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - *74 - - *267 + - *271 requestBody: required: true description: Details of the draft item to create in the project. @@ -41674,7 +43282,7 @@ paths: description: Response content: application/json: - schema: &272 + schema: &276 title: Projects v2 Item description: An item belonging to a project type: object @@ -41688,7 +43296,7 @@ paths: content: oneOf: - *82 - - &462 + - &466 title: Pull Request Simple description: Pull Request Simple type: object @@ -41808,7 +43416,7 @@ paths: milestone: anyOf: - type: 'null' - - *268 + - *272 active_lock_reason: type: - string @@ -41857,7 +43465,7 @@ paths: items: *4 requested_teams: type: array - items: *187 + items: *191 head: type: object properties: @@ -41901,7 +43509,7 @@ paths: _links: type: object properties: - comments: &269 + comments: &273 title: Link description: Hypermedia Link type: object @@ -41910,13 +43518,13 @@ paths: type: string required: - href - commits: *269 - statuses: *269 - html: *269 - issue: *269 - review_comments: *269 - review_comment: *269 - self: *269 + commits: *273 + statuses: *273 + html: *273 + issue: *273 + review_comments: *273 + review_comment: *273 + self: *273 required: - comments - commits @@ -41927,7 +43535,7 @@ paths: - review_comment - self author_association: *79 - auto_merge: &568 + auto_merge: &572 title: Auto merge description: The status of auto merging a pull request. type: @@ -42101,7 +43709,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: &271 + content_type: &275 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -42145,7 +43753,7 @@ paths: - updated_at - archived_at examples: - draft_issue: &273 + draft_issue: &277 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -42219,7 +43827,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization parameters: - - *267 + - *271 - *74 - *17 - *45 @@ -42231,7 +43839,7 @@ paths: application/json: schema: type: array - items: &270 + items: &274 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -42384,7 +43992,7 @@ paths: - updated_at - project_url examples: - default: &694 + default: &699 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -42514,7 +44122,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project parameters: - - *267 + - *271 - *74 requestBody: required: true @@ -42561,7 +44169,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &695 + items: &700 type: object properties: name: @@ -42598,7 +44206,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &696 + iteration_configuration: &701 type: object description: The configuration for iteration fields. properties: @@ -42648,7 +44256,7 @@ paths: value: name: Due date data_type: date - single_select_field: &697 + single_select_field: &702 summary: Create a single select field value: name: Priority @@ -42675,7 +44283,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &698 + iteration_field: &703 summary: Create an iteration field value: name: Sprint @@ -42699,9 +44307,9 @@ paths: description: Response for adding a field to an organization-owned project. content: application/json: - schema: *270 + schema: *274 examples: - text_field: &699 + text_field: &704 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -42710,7 +44318,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-05-15T08:00:00Z' updated_at: '2022-05-15T08:00:00Z' - number_field: &700 + number_field: &705 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -42719,7 +44327,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-01T14:30:00Z' updated_at: '2022-06-01T14:30:00Z' - date_field: &701 + date_field: &706 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -42728,7 +44336,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-10T09:15:00Z' updated_at: '2022-06-10T09:15:00Z' - single_select_field: &702 + single_select_field: &707 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -42762,7 +44370,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &703 + iteration_field: &708 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -42807,8 +44415,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - - *267 - - &704 + - *271 + - &709 name: field_id description: The unique identifier of the field. in: path @@ -42821,9 +44429,9 @@ paths: description: Response content: application/json: - schema: *270 + schema: *274 examples: - default: &705 + default: &710 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -42879,7 +44487,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *267 + - *271 - *74 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) @@ -42912,7 +44520,7 @@ paths: application/json: schema: type: array - items: &274 + items: &278 title: Projects v2 Item description: An item belonging to a project type: object @@ -42929,7 +44537,7 @@ paths: description: The API URL of the project that contains this item. examples: - https://api.github.com/users/monalisa/2/projectsV2/3 - content_type: *271 + content_type: *275 content: type: - object @@ -42979,7 +44587,7 @@ paths: - updated_at - archived_at examples: - default: &275 + default: &279 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -43677,7 +45285,7 @@ paths: url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project parameters: - *74 - - *267 + - *271 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -43747,22 +45355,22 @@ paths: description: Response content: application/json: - schema: *272 + schema: *276 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *273 + value: *277 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *273 + value: *277 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *273 + value: *277 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *273 + value: *277 '304': *35 '403': *27 '401': *23 @@ -43782,9 +45390,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *267 + - *271 - *74 - - &276 + - &280 name: item_id description: The unique identifier of the project item. in: path @@ -43810,9 +45418,9 @@ paths: description: Response content: application/json: - schema: *274 + schema: *278 examples: - default: *275 + default: *279 headers: Link: *66 '304': *35 @@ -43833,9 +45441,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-organization parameters: - - *267 + - *271 - *74 - - *276 + - *280 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -43908,13 +45516,13 @@ paths: description: Response content: application/json: - schema: *274 + schema: *278 examples: - text_field: *275 - number_field: *275 - date_field: *275 - single_select_field: *275 - iteration_field: *275 + text_field: *279 + number_field: *279 + date_field: *279 + single_select_field: *279 + iteration_field: *279 '401': *23 '403': *27 '404': *6 @@ -43934,9 +45542,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization parameters: - - *267 + - *271 - *74 - - *276 + - *280 responses: '204': description: Response @@ -43960,7 +45568,7 @@ paths: url: https://docs.github.com/rest/projects/views#create-a-view-for-an-organization-owned-project parameters: - *74 - - *267 + - *271 requestBody: required: true content: @@ -44034,7 +45642,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &686 + schema: &690 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -44138,7 +45746,7 @@ paths: examples: table_view: summary: Response for creating a table view - value: &277 + value: &281 value: id: 1 number: 1 @@ -44184,10 +45792,10 @@ paths: - 456 board_view: summary: Response for creating a board view with filter - value: *277 + value: *281 roadmap_view: summary: Response for creating a roadmap view - value: *277 + value: *281 '304': *35 '403': *27 '401': *23 @@ -44215,9 +45823,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-project-view parameters: - - *267 + - *271 - *74 - - &706 + - &711 name: view_number description: The number that identifies the project view. in: path @@ -44249,9 +45857,9 @@ paths: application/json: schema: type: array - items: *274 + items: *278 examples: - default: *275 + default: *279 headers: Link: *66 '304': *35 @@ -44284,7 +45892,7 @@ paths: application/json: schema: type: array - items: &278 + items: &282 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -44362,7 +45970,7 @@ paths: - property_name - value_type examples: - default: &279 + default: &283 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -44422,7 +46030,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *278 + items: *282 minItems: 1 maxItems: 100 required: @@ -44452,9 +46060,9 @@ paths: application/json: schema: type: array - items: *278 + items: *282 examples: - default: *279 + default: *283 '403': *27 '404': *6 x-github: @@ -44476,7 +46084,7 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - *74 - - &280 + - &284 name: custom_property_name description: The custom property name in: path @@ -44488,9 +46096,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *282 examples: - default: &281 + default: &285 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -44525,7 +46133,7 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - *74 - - *280 + - *284 requestBody: required: true content: @@ -44605,9 +46213,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *282 examples: - default: *281 + default: *285 '403': *27 '404': *6 x-github: @@ -44631,7 +46239,7 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - *74 - - *280 + - *284 responses: '204': *59 '403': *27 @@ -44695,7 +46303,7 @@ paths: - octocat/Hello-World properties: type: array - items: &282 + items: &286 title: Custom Property Value description: Custom property name and associated value type: object @@ -44785,7 +46393,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *282 + items: *286 required: - repository_names - properties @@ -44977,7 +46585,7 @@ paths: type: array items: *153 examples: - default: *255 + default: *259 headers: Link: *66 x-github: @@ -45180,7 +46788,7 @@ paths: description: Response content: application/json: - schema: &330 + schema: &334 title: Full Repository description: Full Repository type: object @@ -45658,7 +47266,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &467 + code_of_conduct: &471 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -45688,7 +47296,7 @@ paths: - key - name - html_url - security_and_analysis: *283 + security_and_analysis: *287 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -45783,7 +47391,7 @@ paths: has_downloads: version: '2026-03-10' examples: - default: &332 + default: &336 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -46316,7 +47924,7 @@ paths: - *74 - *17 - *19 - - &590 + - &594 name: targets description: | A comma-separated list of rule targets to filter by. @@ -46335,7 +47943,7 @@ paths: application/json: schema: type: array - items: &310 + items: &314 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -46370,7 +47978,7 @@ paths: source: type: string description: The name of the source - enforcement: &286 + enforcement: &290 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -46383,7 +47991,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &287 + items: &291 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -46454,7 +48062,7 @@ paths: description: The html URL of the ruleset conditions: anyOf: - - &284 + - &288 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -46478,7 +48086,7 @@ paths: match. items: type: string - - &288 + - &292 title: Organization ruleset conditions type: object description: |- @@ -46492,7 +48100,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *284 + - *288 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -46526,7 +48134,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *284 + - *288 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -46548,7 +48156,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *284 + - *288 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -46561,7 +48169,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &285 + items: &289 title: Repository ruleset property targeting definition type: object @@ -46594,7 +48202,7 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *285 + items: *289 required: - repository_property type: @@ -46602,12 +48210,12 @@ paths: - object rules: type: array - items: &591 + items: &595 title: Repository Rule type: object description: A repository rule. oneOf: - - &289 + - &293 title: creation description: Only allow users with bypass permission to create matching refs. @@ -46619,7 +48227,7 @@ paths: type: string enum: - creation - - &290 + - &294 title: update description: Only allow users with bypass permission to update matching refs. @@ -46640,7 +48248,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &291 + - &295 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -46652,7 +48260,7 @@ paths: type: string enum: - deletion - - &292 + - &296 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -46664,7 +48272,7 @@ paths: type: string enum: - required_linear_history - - &589 + - &593 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -46742,7 +48350,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &293 + - &297 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -46766,7 +48374,7 @@ paths: type: string required: - required_deployment_environments - - &294 + - &298 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -46778,7 +48386,7 @@ paths: type: string enum: - required_signatures - - &295 + - &299 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -46884,7 +48492,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &296 + - &300 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -46932,7 +48540,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &297 + - &301 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -46944,7 +48552,7 @@ paths: type: string enum: - non_fast_forward - - &298 + - &302 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -46981,7 +48589,7 @@ paths: required: - operator - pattern - - &299 + - &303 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -47018,7 +48626,7 @@ paths: required: - operator - pattern - - &300 + - &304 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -47055,7 +48663,7 @@ paths: required: - operator - pattern - - &301 + - &305 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -47092,7 +48700,7 @@ paths: required: - operator - pattern - - &302 + - &306 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -47129,7 +48737,7 @@ paths: required: - operator - pattern - - &303 + - &307 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -47154,7 +48762,7 @@ paths: type: string required: - restricted_file_paths - - &304 + - &308 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -47178,7 +48786,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &305 + - &309 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -47201,7 +48809,7 @@ paths: type: string required: - restricted_file_extensions - - &306 + - &310 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -47226,7 +48834,7 @@ paths: maximum: 100 required: - max_file_size - - &307 + - &311 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -47276,7 +48884,7 @@ paths: - repository_id required: - workflows - - &308 + - &312 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -47337,7 +48945,7 @@ paths: - tool required: - code_scanning_tools - - &309 + - &313 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -47436,24 +49044,20 @@ paths: - push - repository default: branch - enforcement: *286 + enforcement: *290 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *287 - conditions: *288 + items: *291 + conditions: *292 rules: type: array description: An array of rules within the ruleset. - items: &312 + items: &316 title: Repository Rule type: object description: A repository rule. oneOf: - - *289 - - *290 - - *291 - - *292 - *293 - *294 - *295 @@ -47471,6 +49075,10 @@ paths: - *307 - *308 - *309 + - *310 + - *311 + - *312 + - *313 required: - name - enforcement @@ -47508,9 +49116,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *314 examples: - default: &311 + default: &315 value: id: 21 name: super cool ruleset @@ -47566,7 +49174,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *74 - - &592 + - &596 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -47581,7 +49189,7 @@ paths: in: query schema: type: string - - &593 + - &597 name: time_period description: |- The time period to filter by. @@ -47597,14 +49205,14 @@ paths: - week - month default: day - - &594 + - &598 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &595 + - &599 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -47624,7 +49232,7 @@ paths: description: Response content: application/json: - schema: &596 + schema: &600 title: Rule Suites description: Response type: array @@ -47680,7 +49288,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &597 + default: &601 value: - id: 21 actor_id: 12 @@ -47724,7 +49332,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *74 - - &598 + - &602 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -47740,7 +49348,7 @@ paths: description: Response content: application/json: - schema: &599 + schema: &603 title: Rule Suite description: Response type: object @@ -47847,7 +49455,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &600 + default: &604 value: id: 21 actor_id: 12 @@ -47920,9 +49528,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *314 examples: - default: *311 + default: *315 '404': *6 '500': *53 put: @@ -47966,16 +49574,16 @@ paths: - tag - push - repository - enforcement: *286 + enforcement: *290 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *287 - conditions: *288 + items: *291 + conditions: *292 rules: description: An array of rules within the ruleset. type: array - items: *312 + items: *316 examples: default: value: @@ -48010,9 +49618,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *314 examples: - default: *311 + default: *315 '404': *6 '422': *15 '500': *53 @@ -48070,7 +49678,7 @@ paths: application/json: schema: type: array - items: &313 + items: &317 title: Ruleset version type: object description: The historical version of a ruleset @@ -48094,7 +49702,7 @@ paths: type: string format: date-time examples: - default: &602 + default: &606 value: - version_id: 3 actor: @@ -48147,9 +49755,9 @@ paths: description: Response content: application/json: - schema: &603 + schema: &607 allOf: - - *313 + - *317 - type: object required: - state @@ -48219,7 +49827,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *74 - - &604 + - &608 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -48230,7 +49838,7 @@ paths: enum: - open - resolved - - &605 + - &609 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -48240,7 +49848,7 @@ paths: required: false schema: type: string - - &606 + - &610 name: exclude_secret_types in: query description: A comma-separated list of secret types to exclude from the results. @@ -48251,7 +49859,7 @@ paths: required: false schema: type: string - - &607 + - &611 name: exclude_providers in: query description: |- @@ -48262,7 +49870,7 @@ paths: required: false schema: type: string - - &608 + - &612 name: providers in: query description: |- @@ -48273,7 +49881,7 @@ paths: required: false schema: type: string - - &609 + - &613 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -48282,7 +49890,7 @@ paths: required: false schema: type: string - - &610 + - &614 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -48301,7 +49909,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &611 + - &615 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -48316,7 +49924,7 @@ paths: - *60 - *19 - *17 - - &612 + - &616 name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -48326,7 +49934,7 @@ paths: required: false schema: type: string - - &613 + - &617 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -48336,7 +49944,7 @@ paths: required: false schema: type: string - - &614 + - &618 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -48345,7 +49953,7 @@ paths: required: false schema: type: string - - &615 + - &619 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -48354,7 +49962,7 @@ paths: schema: type: boolean default: false - - &616 + - &620 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -48363,7 +49971,7 @@ paths: schema: type: boolean default: false - - &617 + - &621 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -48395,14 +50003,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &618 + state: &622 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &619 + resolution: &623 type: - string - 'null' @@ -48521,14 +50129,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &620 + - &624 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &622 + - &626 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -48592,7 +50200,7 @@ paths: - blob_url - commit_sha - commit_url - - &623 + - &627 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -48653,7 +50261,7 @@ paths: - page_url - commit_sha - commit_url - - &624 + - &628 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -48675,7 +50283,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &625 + - &629 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -48697,7 +50305,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &626 + - &630 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -48719,7 +50327,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &627 + - &631 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -48734,7 +50342,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &628 + - &632 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -48749,7 +50357,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &629 + - &633 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -48764,7 +50372,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &630 + - &634 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -48786,7 +50394,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &631 + - &635 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -48808,7 +50416,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &632 + - &636 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -48830,7 +50438,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &633 + - &637 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -48852,7 +50460,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &634 + - &638 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull @@ -49113,7 +50721,7 @@ paths: related to push protection. type: object properties: - pattern_config_version: &315 + pattern_config_version: &319 type: - string - 'null' @@ -49123,7 +50731,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &314 + items: &318 type: object properties: token_type: @@ -49192,7 +50800,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *314 + items: *318 examples: default: value: @@ -49249,7 +50857,7 @@ paths: schema: type: object properties: - pattern_config_version: *315 + pattern_config_version: *319 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -49275,7 +50883,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *315 + custom_pattern_version: *319 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -49373,7 +50981,7 @@ paths: application/json: schema: type: array - items: &638 + items: &642 description: A repository security advisory. type: object properties: @@ -49617,7 +51225,7 @@ paths: login: type: string description: The username of the user credited. - type: *316 + type: *320 credits_detailed: type: - array @@ -49628,7 +51236,7 @@ paths: type: object properties: user: *4 - type: *316 + type: *320 state: type: string description: The state of the user's acceptance of the @@ -49654,7 +51262,7 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *187 + items: *191 private_fork: readOnly: true description: A temporary private fork of the advisory's repository @@ -49724,7 +51332,7 @@ paths: - private_fork version: '2026-03-10' examples: - default: &639 + default: &643 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -50111,7 +51719,7 @@ paths: application/json: schema: type: array - items: *247 + items: *251 examples: default: value: @@ -50466,7 +52074,7 @@ paths: type: integer network_configurations: type: array - items: &317 + items: &321 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -50619,9 +52227,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *321 examples: - default: &318 + default: &322 value: id: 123456789ABCDEF name: My network configuration @@ -50650,7 +52258,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - *74 - - &319 + - &323 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -50662,9 +52270,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *321 examples: - default: *318 + default: *322 headers: Link: *66 x-github: @@ -50686,7 +52294,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - *74 - - *319 + - *323 requestBody: required: true content: @@ -50739,9 +52347,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *321 examples: - default: *318 + default: *322 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50761,7 +52369,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - *74 - - *319 + - *323 responses: '204': description: Response @@ -50906,13 +52514,13 @@ paths: application/json: schema: type: array - items: *320 + items: *324 examples: - default: *321 + default: *325 '500': *53 '403': *27 '404': *6 - '422': *322 + '422': *326 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50952,9 +52560,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - default: *248 + default: *252 headers: Link: *66 '403': *27 @@ -51048,7 +52656,7 @@ paths: description: Response content: application/json: - schema: &323 + schema: &327 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -51122,7 +52730,7 @@ paths: parent: anyOf: - type: 'null' - - *247 + - *251 members_count: type: integer examples: @@ -51447,7 +53055,7 @@ paths: - repos_count - organization examples: - default: &324 + default: &328 value: id: 1 node_id: MDQ6VGVhbTE= @@ -51535,9 +53143,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '404': *6 x-github: githubCloudOnly: false @@ -51622,16 +53230,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '201': description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '404': *6 '422': *15 '403': *27 @@ -51661,7 +53269,7 @@ paths: responses: '204': description: Response - '422': &325 + '422': &329 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -51695,12 +53303,12 @@ paths: application/json: schema: type: array - items: *226 + items: *230 examples: - default: *227 + default: *231 headers: Link: *66 - '422': *325 + '422': *329 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51782,7 +53390,7 @@ paths: description: Response content: application/json: - schema: &326 + schema: &330 title: Team Membership description: Team Membership type: object @@ -51810,7 +53418,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &654 + response-if-user-is-a-team-maintainer: &658 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -51873,9 +53481,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *330 examples: - response-if-users-membership-with-team-is-now-pending: &655 + response-if-users-membership-with-team-is-now-pending: &659 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -51951,7 +53559,7 @@ paths: type: array items: *153 examples: - default: *255 + default: *259 headers: Link: *66 x-github: @@ -51982,14 +53590,14 @@ paths: parameters: - *74 - *76 - - *327 - - *328 + - *331 + - *332 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &656 + schema: &660 title: Team Repository description: A team's access to a repository. type: object @@ -52717,8 +54325,8 @@ paths: parameters: - *74 - *76 - - *327 - - *328 + - *331 + - *332 requestBody: required: false content: @@ -52765,8 +54373,8 @@ paths: parameters: - *74 - *76 - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -52801,9 +54409,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - response-if-child-teams-exist: &657 + response-if-child-teams-exist: &661 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -52957,7 +54565,7 @@ paths: resources: type: object properties: - core: &329 + core: &333 title: Rate Limit type: object properties: @@ -52974,21 +54582,21 @@ paths: - remaining - reset - used - graphql: *329 - search: *329 - code_search: *329 - source_import: *329 - integration_manifest: *329 - code_scanning_upload: *329 - actions_runner_registration: *329 - scim: *329 - dependency_snapshots: *329 - dependency_sbom: *329 - code_scanning_autofix: *329 + graphql: *333 + search: *333 + code_search: *333 + source_import: *333 + integration_manifest: *333 + code_scanning_upload: *333 + actions_runner_registration: *333 + scim: *333 + dependency_snapshots: *333 + dependency_sbom: *333 + code_scanning_autofix: *333 required: - core - search - rate: *329 + rate: *333 required: - rate - resources @@ -53107,14 +54715,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *330 + schema: *334 examples: default-response: summary: Default response @@ -53625,7 +55233,7 @@ paths: version: '2026-03-10' '403': *27 '404': *6 - '301': *331 + '301': *335 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53643,8 +55251,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: false content: @@ -53943,10 +55551,10 @@ paths: description: Response content: application/json: - schema: *330 + schema: *334 examples: - default: *332 - '307': &333 + default: *336 + '307': &337 description: Temporary Redirect content: application/json: @@ -53975,8 +55583,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -53998,7 +55606,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *333 + '307': *337 '404': *6 '409': *52 x-github: @@ -54022,11 +55630,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 - - &366 + - &370 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -54049,7 +55657,7 @@ paths: type: integer artifacts: type: array - items: &334 + items: &338 title: Artifact description: An artifact type: object @@ -54144,7 +55752,7 @@ paths: - expires_at - updated_at examples: - default: &367 + default: &371 value: total_count: 2 artifacts: @@ -54205,9 +55813,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *327 - - *328 - - &335 + - *331 + - *332 + - &339 name: artifact_id description: The unique identifier of the artifact. in: path @@ -54219,7 +55827,7 @@ paths: description: Response content: application/json: - schema: *334 + schema: *338 examples: default: value: @@ -54257,9 +55865,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *327 - - *328 - - *335 + - *331 + - *332 + - *339 responses: '204': description: Response @@ -54283,9 +55891,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *327 - - *328 - - *335 + - *331 + - *332 + - *339 - name: archive_format in: path required: true @@ -54295,11 +55903,11 @@ paths: '302': description: Response headers: - Location: &484 + Location: &488 example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': &525 + '410': &529 description: Gone content: application/json: @@ -54324,14 +55932,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: &336 + schema: &340 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -54365,13 +55973,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: application/json: - schema: *336 + schema: *340 examples: selected_actions: *40 responses: @@ -54400,14 +56008,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: &337 + schema: &341 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -54441,13 +56049,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: application/json: - schema: *337 + schema: *341 examples: selected_actions: *42 responses: @@ -54478,14 +56086,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *338 + schema: *342 examples: default: value: @@ -54511,11 +56119,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 - - &339 + - &343 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -54549,7 +56157,7 @@ paths: description: Response content: application/json: - schema: &340 + schema: &344 title: Repository actions caches description: Repository actions caches type: object @@ -54599,7 +56207,7 @@ paths: - total_count - actions_caches examples: - default: &341 + default: &345 value: total_count: 1 actions_caches: @@ -54631,23 +56239,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *327 - - *328 + - *331 + - *332 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *339 + - *343 responses: '200': description: Response content: application/json: - schema: *340 + schema: *344 examples: - default: *341 + default: *345 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54667,8 +56275,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *327 - - *328 + - *331 + - *332 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -54699,9 +56307,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *327 - - *328 - - &342 + - *331 + - *332 + - &346 name: job_id description: The unique identifier of the job. in: path @@ -54713,7 +56321,7 @@ paths: description: Response content: application/json: - schema: &370 + schema: &374 title: Job description: Information of a job execution in a workflow run type: object @@ -55060,9 +56668,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *327 - - *328 - - *342 + - *331 + - *332 + - *346 responses: '302': description: Response @@ -55090,9 +56698,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *327 - - *328 - - *342 + - *331 + - *332 + - *346 requestBody: required: false content: @@ -55138,8 +56746,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Status response @@ -55160,6 +56768,15 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether the repository has opted in to the immutable + OIDC subject claim format. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. If not set at the + repository level, falls back to the organization-level setting. + type: boolean + sub_claim_prefix: + description: The current `sub` claim prefix for this repository. + type: string required: - use_default examples: @@ -55189,8 +56806,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -55212,6 +56829,11 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for this repository. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. + type: boolean examples: default: value: @@ -55253,8 +56875,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -55272,7 +56894,7 @@ paths: type: integer secrets: type: array - items: &372 + items: &376 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -55293,7 +56915,7 @@ paths: - created_at - updated_at examples: - default: &373 + default: &377 value: total_count: 2 secrets: @@ -55326,9 +56948,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *327 - - *328 - - *343 + - *331 + - *332 + - *347 - *19 responses: '200': @@ -55345,7 +56967,7 @@ paths: type: integer variables: type: array - items: &376 + items: &380 title: Actions Variable type: object properties: @@ -55379,7 +57001,7 @@ paths: - created_at - updated_at examples: - default: &377 + default: &381 value: total_count: 2 variables: @@ -55412,8 +57034,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -55422,11 +57044,11 @@ paths: schema: type: object properties: - enabled: &345 + enabled: &349 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *138 - selected_actions_url: *344 + selected_actions_url: *348 sha_pinning_required: *139 required: - enabled @@ -55455,8 +57077,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -55467,7 +57089,7 @@ paths: schema: type: object properties: - enabled: *345 + enabled: *349 allowed_actions: *138 sha_pinning_required: *139 required: @@ -55499,14 +57121,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: &346 + schema: &350 type: object properties: access_level: @@ -55523,7 +57145,7 @@ paths: required: - access_level examples: - default: &347 + default: &351 value: access_level: organization x-github: @@ -55547,15 +57169,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: application/json: - schema: *346 + schema: *350 examples: - default: *347 + default: *351 responses: '204': description: Response @@ -55579,14 +57201,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *348 + schema: *352 examples: default: value: @@ -55610,8 +57232,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Empty response for successful settings update @@ -55621,7 +57243,7 @@ paths: required: true content: application/json: - schema: *349 + schema: *353 examples: default: summary: Set retention days @@ -55645,8 +57267,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -55654,7 +57276,7 @@ paths: application/json: schema: *140 examples: - default: *350 + default: *354 '404': *6 x-github: enabledForGitHubApps: true @@ -55673,8 +57295,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -55708,14 +57330,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *351 + schema: *355 examples: default: *141 '403': *27 @@ -55737,13 +57359,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: application/json: - schema: *352 + schema: *356 examples: default: *141 responses: @@ -55769,8 +57391,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -55797,8 +57419,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -55830,14 +57452,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *353 + schema: *357 examples: default: *148 x-github: @@ -55860,8 +57482,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Success response @@ -55872,7 +57494,7 @@ paths: required: true content: application/json: - schema: *354 + schema: *358 examples: default: *148 x-github: @@ -55901,8 +57523,8 @@ paths: in: query schema: type: string - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -55946,8 +57568,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -55955,9 +57577,9 @@ paths: application/json: schema: type: array - items: *355 + items: *359 examples: - default: *356 + default: *360 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55979,8 +57601,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -56023,7 +57645,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *357 + '201': *361 '404': *6 '422': *7 '409': *52 @@ -56054,8 +57676,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '201': description: Response @@ -56063,7 +57685,7 @@ paths: application/json: schema: *157 examples: - default: *358 + default: *362 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56091,8 +57713,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '201': description: Response @@ -56100,7 +57722,7 @@ paths: application/json: schema: *157 examples: - default: *359 + default: *363 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56122,8 +57744,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *154 responses: '200': @@ -56132,7 +57754,7 @@ paths: application/json: schema: *155 examples: - default: *360 + default: *364 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56153,8 +57775,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *154 responses: '204': @@ -56181,8 +57803,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *154 responses: '200': *159 @@ -56207,8 +57829,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *154 requestBody: required: true @@ -56257,8 +57879,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *154 requestBody: required: true @@ -56308,11 +57930,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *154 responses: - '200': *361 + '200': *365 '404': *6 x-github: githubCloudOnly: false @@ -56339,10 +57961,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *154 - - *362 + - *366 responses: '200': *159 '404': *6 @@ -56370,9 +57992,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *327 - - *328 - - &380 + - *331 + - *332 + - &384 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -56380,7 +58002,7 @@ paths: required: false schema: type: string - - &381 + - &385 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -56388,7 +58010,7 @@ paths: required: false schema: type: string - - &382 + - &386 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -56397,7 +58019,7 @@ paths: required: false schema: type: string - - &383 + - &387 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -56424,7 +58046,7 @@ paths: - pending - *17 - *19 - - &384 + - &388 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -56433,7 +58055,7 @@ paths: schema: type: string format: date-time - - &363 + - &367 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -56442,13 +58064,13 @@ paths: schema: type: boolean default: false - - &385 + - &389 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &386 + - &390 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -56471,7 +58093,7 @@ paths: type: integer workflow_runs: type: array - items: &364 + items: &368 title: Workflow Run description: An invocation of a workflow type: object @@ -56649,7 +58271,7 @@ paths: head_commit: anyOf: - type: 'null' - - &408 + - &412 title: Simple Commit description: A commit. type: object @@ -56764,7 +58386,7 @@ paths: - workflow_url - pull_requests examples: - default: &387 + default: &391 value: total_count: 1 workflow_runs: @@ -57000,24 +58622,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *327 - - *328 - - &365 + - *331 + - *332 + - &369 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *363 + - *367 responses: '200': description: Response content: application/json: - schema: *364 + schema: *368 examples: - default: &368 + default: &372 value: id: 30433642 name: Build @@ -57258,9 +58880,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '204': description: Response @@ -57283,9 +58905,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '200': description: Response @@ -57413,9 +59035,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '201': description: Response @@ -57448,12 +59070,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 - *17 - *19 - - *366 + - *370 - *60 responses: '200': @@ -57470,9 +59092,9 @@ paths: type: integer artifacts: type: array - items: *334 + items: *338 examples: - default: *367 + default: *371 headers: Link: *66 x-github: @@ -57496,25 +59118,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *327 - - *328 - - *365 - - &369 + - *331 + - *332 + - *369 + - &373 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *363 + - *367 responses: '200': description: Response content: application/json: - schema: *364 + schema: *368 examples: - default: *368 + default: *372 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57537,10 +59159,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *327 - - *328 - - *365 + - *331 + - *332 - *369 + - *373 - *17 - *19 responses: @@ -57558,9 +59180,9 @@ paths: type: integer jobs: type: array - items: *370 + items: *374 examples: - default: &371 + default: &375 value: total_count: 1 jobs: @@ -57673,10 +59295,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *327 - - *328 - - *365 + - *331 + - *332 - *369 + - *373 responses: '302': description: Response @@ -57704,9 +59326,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '202': description: Response @@ -57739,9 +59361,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 requestBody: required: true content: @@ -57808,9 +59430,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '202': description: Response @@ -57843,9 +59465,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -57875,9 +59497,9 @@ paths: type: integer jobs: type: array - items: *370 + items: *374 examples: - default: *371 + default: *375 headers: Link: *66 x-github: @@ -57902,9 +59524,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '302': description: Response @@ -57931,9 +59553,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '204': description: Response @@ -57960,9 +59582,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '200': description: Response @@ -58031,7 +59653,7 @@ paths: items: type: object properties: - type: &491 + type: &495 type: string description: The type of reviewer. enum: @@ -58042,7 +59664,7 @@ paths: reviewer: anyOf: - *4 - - *187 + - *191 required: - environment - wait_timer @@ -58117,9 +59739,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 requestBody: required: true content: @@ -58169,7 +59791,7 @@ paths: application/json: schema: type: array - items: &486 + items: &490 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -58281,7 +59903,7 @@ paths: - created_at - updated_at examples: - default: &487 + default: &491 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -58337,9 +59959,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 requestBody: required: false content: @@ -58384,9 +60006,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 requestBody: required: false content: @@ -58440,9 +60062,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *327 - - *328 - - *365 + - *331 + - *332 + - *369 responses: '200': description: Response @@ -58579,8 +60201,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -58598,9 +60220,9 @@ paths: type: integer secrets: type: array - items: *372 + items: *376 examples: - default: *373 + default: *377 headers: Link: *66 x-github: @@ -58625,16 +60247,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *374 + schema: *378 examples: - default: *375 + default: *379 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58656,17 +60278,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 responses: '200': description: Response content: application/json: - schema: *372 + schema: *376 examples: - default: &504 + default: &508 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -58692,8 +60314,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 requestBody: required: true @@ -58751,8 +60373,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 responses: '204': @@ -58778,9 +60400,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *327 - - *328 - - *343 + - *331 + - *332 + - *347 - *19 responses: '200': @@ -58797,9 +60419,9 @@ paths: type: integer variables: type: array - items: *376 + items: *380 examples: - default: *377 + default: *381 headers: Link: *66 x-github: @@ -58822,8 +60444,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -58875,17 +60497,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *327 - - *328 + - *331 + - *332 - *164 responses: '200': description: Response content: application/json: - schema: *376 + schema: *380 examples: - default: &505 + default: &509 value: name: USERNAME value: octocat @@ -58911,8 +60533,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *327 - - *328 + - *331 + - *332 - *164 requestBody: required: true @@ -58955,8 +60577,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *327 - - *328 + - *331 + - *332 - *164 responses: '204': @@ -58982,8 +60604,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -59001,7 +60623,7 @@ paths: type: integer workflows: type: array - items: &378 + items: &382 title: Workflow description: A GitHub Actions workflow type: object @@ -59119,9 +60741,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *327 - - *328 - - &379 + - *331 + - *332 + - &383 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -59136,7 +60758,7 @@ paths: description: Response content: application/json: - schema: *378 + schema: *382 examples: default: value: @@ -59169,9 +60791,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *327 - - *328 - - *379 + - *331 + - *332 + - *383 responses: '204': description: Response @@ -59196,9 +60818,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *327 - - *328 - - *379 + - *331 + - *332 + - *383 responses: '204': description: Empty response when `return_run_details` parameter is `false`. @@ -59278,6 +60900,9 @@ paths: path: "/responses/204" - op: remove path: "/requestBody/content/application~1json/schema/properties/return_run_details" + - op: replace + path: "/responses/200/description" + value: Response including the workflow run ID and URLs. version: '2026-03-10' "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": put: @@ -59293,9 +60918,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *327 - - *328 - - *379 + - *331 + - *332 + - *383 responses: '204': description: Response @@ -59322,19 +60947,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *327 - - *328 - - *379 - - *380 - - *381 - - *382 + - *331 + - *332 - *383 - - *17 - - *19 - *384 - - *363 - *385 - *386 + - *387 + - *17 + - *19 + - *388 + - *367 + - *389 + - *390 responses: '200': description: Response @@ -59350,9 +60975,9 @@ paths: type: integer workflow_runs: type: array - items: *364 + items: *368 examples: - default: *387 + default: *391 headers: Link: *66 x-github: @@ -59384,9 +61009,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *327 - - *328 - - *379 + - *331 + - *332 + - *383 responses: '200': description: Response @@ -59447,8 +61072,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *327 - - *328 + - *331 + - *332 - *60 - *17 - *45 @@ -59616,8 +61241,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -59654,8 +61279,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *327 - - *328 + - *331 + - *332 - name: assignee in: path required: true @@ -59691,8 +61316,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#create-an-attestation parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -59802,8 +61427,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#list-attestations parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *45 - *46 @@ -59860,7 +61485,7 @@ paths: initiator: type: string examples: - default: *388 + default: *392 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59894,8 +61519,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -59903,7 +61528,7 @@ paths: application/json: schema: type: array - items: &389 + items: &393 title: Autolink reference description: An autolink reference. type: object @@ -59962,8 +61587,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -60002,9 +61627,9 @@ paths: description: response content: application/json: - schema: *389 + schema: *393 examples: - default: &390 + default: &394 value: id: 1 key_prefix: TICKET- @@ -60035,9 +61660,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *327 - - *328 - - &391 + - *331 + - *332 + - &395 name: autolink_id description: The unique identifier of the autolink. in: path @@ -60049,9 +61674,9 @@ paths: description: Response content: application/json: - schema: *389 + schema: *393 examples: - default: *390 + default: *394 '404': *6 x-github: githubCloudOnly: false @@ -60071,9 +61696,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *327 - - *328 - - *391 + - *331 + - *332 + - *395 responses: '204': description: Response @@ -60097,8 +61722,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response if Dependabot is enabled @@ -60148,8 +61773,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -60170,8 +61795,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -60191,8 +61816,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *327 - - *328 + - *331 + - *332 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -60230,7 +61855,7 @@ paths: - url protected: type: boolean - protection: &393 + protection: &397 title: Branch Protection description: Branch Protection type: object @@ -60273,7 +61898,7 @@ paths: required: - contexts - checks - enforce_admins: &396 + enforce_admins: &400 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -60290,7 +61915,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &398 + required_pull_request_reviews: &402 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -60312,7 +61937,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *187 + items: *191 apps: description: The list of apps with review dismissal access. @@ -60344,7 +61969,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *187 + items: *191 apps: description: The list of apps allowed to bypass pull request requirements. @@ -60374,7 +61999,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &395 + restrictions: &399 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -60437,7 +62062,7 @@ paths: type: string teams: type: array - items: *187 + items: *191 apps: type: array items: @@ -60667,9 +62292,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *327 - - *328 - - &394 + - *331 + - *332 + - &398 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). @@ -60683,14 +62308,14 @@ paths: description: Response content: application/json: - schema: &404 + schema: &408 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &458 + commit: &462 title: Commit description: Commit type: object @@ -60729,7 +62354,7 @@ paths: author: anyOf: - type: 'null' - - &392 + - &396 title: Git User description: Metaproperties for Git author/committer information. @@ -60751,7 +62376,7 @@ paths: committer: anyOf: - type: 'null' - - *392 + - *396 message: type: string examples: @@ -60775,7 +62400,7 @@ paths: required: - sha - url - verification: &511 + verification: &515 title: Verification type: object properties: @@ -60855,7 +62480,7 @@ paths: type: integer files: type: array - items: &469 + items: &473 title: Diff Entry description: Diff Entry type: object @@ -60951,7 +62576,7 @@ paths: - self protected: type: boolean - protection: *393 + protection: *397 protection_url: type: string format: uri @@ -61060,7 +62685,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *331 + '301': *335 '404': *6 x-github: githubCloudOnly: false @@ -61082,15 +62707,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *393 + schema: *397 examples: default: value: @@ -61284,9 +62909,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -61546,7 +63171,7 @@ paths: url: type: string format: uri - required_status_checks: &401 + required_status_checks: &405 title: Status Check Policy description: Status Check Policy type: object @@ -61627,7 +63252,7 @@ paths: items: *4 teams: type: array - items: *187 + items: *191 apps: type: array items: *5 @@ -61645,7 +63270,7 @@ paths: items: *4 teams: type: array - items: *187 + items: *191 apps: type: array items: *5 @@ -61705,7 +63330,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *395 + restrictions: *399 required_conversation_resolution: type: object properties: @@ -61817,9 +63442,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '204': description: Response @@ -61844,17 +63469,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *396 + schema: *400 examples: - default: &397 + default: &401 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -61876,17 +63501,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *396 + schema: *400 examples: - default: *397 + default: *401 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61905,9 +63530,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '204': description: Response @@ -61932,17 +63557,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *398 + schema: *402 examples: - default: &399 + default: &403 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -62038,9 +63663,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: false content: @@ -62138,9 +63763,9 @@ paths: description: Response content: application/json: - schema: *398 + schema: *402 examples: - default: *399 + default: *403 '422': *15 x-github: githubCloudOnly: false @@ -62161,9 +63786,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '204': description: Response @@ -62190,17 +63815,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *396 + schema: *400 examples: - default: &400 + default: &404 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -62223,17 +63848,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *396 + schema: *400 examples: - default: *400 + default: *404 '404': *6 x-github: githubCloudOnly: false @@ -62253,9 +63878,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '204': description: Response @@ -62280,17 +63905,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *401 + schema: *405 examples: - default: &402 + default: &406 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -62316,9 +63941,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: false content: @@ -62370,9 +63995,9 @@ paths: description: Response content: application/json: - schema: *401 + schema: *405 examples: - default: *402 + default: *406 '404': *6 '422': *15 x-github: @@ -62394,9 +64019,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '204': description: Response @@ -62420,9 +64045,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response @@ -62456,9 +64081,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: false content: @@ -62525,9 +64150,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: false content: @@ -62591,9 +64216,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: content: application/json: @@ -62659,15 +64284,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response content: application/json: - schema: *395 + schema: *399 examples: default: value: @@ -62758,9 +64383,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '204': description: Response @@ -62783,9 +64408,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response @@ -62795,7 +64420,7 @@ paths: type: array items: *5 examples: - default: &403 + default: &407 value: - id: 1 slug: octoapp @@ -62852,9 +64477,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -62888,7 +64513,7 @@ paths: type: array items: *5 examples: - default: *403 + default: *407 '422': *15 x-github: githubCloudOnly: false @@ -62909,9 +64534,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -62945,7 +64570,7 @@ paths: type: array items: *5 examples: - default: *403 + default: *407 '422': *15 x-github: githubCloudOnly: false @@ -62966,9 +64591,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -63002,7 +64627,7 @@ paths: type: array items: *5 examples: - default: *403 + default: *407 '422': *15 x-github: githubCloudOnly: false @@ -63024,9 +64649,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response @@ -63034,9 +64659,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - default: *248 + default: *252 '404': *6 x-github: githubCloudOnly: false @@ -63056,9 +64681,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: false content: @@ -63094,9 +64719,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - default: *248 + default: *252 '422': *15 x-github: githubCloudOnly: false @@ -63117,9 +64742,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: false content: @@ -63155,9 +64780,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - default: *248 + default: *252 '422': *15 x-github: githubCloudOnly: false @@ -63178,9 +64803,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: content: application/json: @@ -63215,9 +64840,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - default: *248 + default: *252 '422': *15 x-github: githubCloudOnly: false @@ -63239,9 +64864,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 responses: '200': description: Response @@ -63275,9 +64900,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -63335,9 +64960,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -63395,9 +65020,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -63457,9 +65082,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 requestBody: required: true content: @@ -63481,7 +65106,7 @@ paths: description: Response content: application/json: - schema: *404 + schema: *408 examples: default: value: @@ -63597,8 +65222,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -63877,7 +65502,7 @@ paths: description: Response content: application/json: - schema: &405 + schema: &409 title: CheckRun description: A check performed on the code of a given code change type: object @@ -64013,7 +65638,7 @@ paths: check. type: array items: *85 - deployment: &719 + deployment: &724 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -64300,9 +65925,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *327 - - *328 - - &406 + - *331 + - *332 + - &410 name: check_run_id description: The unique identifier of the check run. in: path @@ -64314,9 +65939,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *409 examples: - default: &407 + default: &411 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -64416,9 +66041,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *327 - - *328 - - *406 + - *331 + - *332 + - *410 requestBody: required: true content: @@ -64658,9 +66283,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *409 examples: - default: *407 + default: *411 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64680,9 +66305,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *327 - - *328 - - *406 + - *331 + - *332 + - *410 - *17 - *19 responses: @@ -64792,9 +66417,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *327 - - *328 - - *406 + - *331 + - *332 + - *410 responses: '201': description: Response @@ -64838,8 +66463,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -64861,7 +66486,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &409 + schema: &413 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -64959,7 +66584,7 @@ paths: - string - 'null' format: date-time - head_commit: *408 + head_commit: *412 latest_check_runs_count: type: integer check_runs_url: @@ -64987,7 +66612,7 @@ paths: - check_runs_url - pull_requests examples: - default: &410 + default: &414 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -65278,9 +66903,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *409 + schema: *413 examples: - default: *410 + default: *414 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65299,8 +66924,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -65609,9 +67234,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *327 - - *328 - - &411 + - *331 + - *332 + - &415 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -65623,9 +67248,9 @@ paths: description: Response content: application/json: - schema: *409 + schema: *413 examples: - default: *410 + default: *414 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65648,17 +67273,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *327 - - *328 - - *411 - - &464 + - *331 + - *332 + - *415 + - &468 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &465 + - &469 name: status description: Returns check runs with the specified `status`. in: query @@ -65697,9 +67322,9 @@ paths: type: integer check_runs: type: array - items: *405 + items: *409 examples: - default: &466 + default: &470 value: total_count: 1 check_runs: @@ -65801,9 +67426,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *327 - - *328 - - *411 + - *331 + - *332 + - *415 responses: '201': description: Response @@ -65836,21 +67461,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *327 - - *328 - - *412 - - *413 + - *331 + - *332 + - *416 + - *417 - *19 - *17 - - &430 + - &434 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *414 - - &431 + schema: *418 + - &435 name: pr description: The number of the pull request for the results you want to list. in: query @@ -65875,13 +67500,13 @@ paths: be returned. in: query required: false - schema: *415 + schema: *419 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *416 + schema: *420 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -65905,7 +67530,7 @@ paths: updated_at: *173 url: *174 html_url: *175 - instances_url: *417 + instances_url: *421 state: *180 fixed_at: *176 dismissed_by: @@ -65913,11 +67538,11 @@ paths: - type: 'null' - *4 dismissed_at: *177 - dismissed_reason: *418 - dismissed_comment: *419 - rule: *420 - tool: *421 - most_recent_instance: *422 + dismissed_reason: *422 + dismissed_comment: *423 + rule: *424 + tool: *425 + most_recent_instance: *426 dismissal_approved_by: anyOf: - type: 'null' @@ -66040,7 +67665,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &423 + '403': &427 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -66067,9 +67692,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *327 - - *328 - - &424 + - *331 + - *332 + - &428 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -66083,7 +67708,7 @@ paths: description: Response content: application/json: - schema: &425 + schema: &429 type: object properties: number: *171 @@ -66091,7 +67716,7 @@ paths: updated_at: *173 url: *174 html_url: *175 - instances_url: *417 + instances_url: *421 state: *180 fixed_at: *176 dismissed_by: @@ -66099,8 +67724,8 @@ paths: - type: 'null' - *4 dismissed_at: *177 - dismissed_reason: *418 - dismissed_comment: *419 + dismissed_reason: *422 + dismissed_comment: *423 rule: type: object properties: @@ -66162,8 +67787,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *421 - most_recent_instance: *422 + tool: *425 + most_recent_instance: *426 dismissal_approved_by: anyOf: - type: 'null' @@ -66259,7 +67884,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *423 + '403': *427 '404': *6 '503': *114 x-github: @@ -66279,9 +67904,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *327 - - *328 - - *424 + - *331 + - *332 + - *428 requestBody: required: true content: @@ -66296,8 +67921,8 @@ paths: enum: - open - dismissed - dismissed_reason: *418 - dismissed_comment: *419 + dismissed_reason: *422 + dismissed_comment: *423 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -66325,7 +67950,7 @@ paths: description: Response content: application/json: - schema: *425 + schema: *429 examples: default: value: @@ -66401,7 +68026,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &429 + '403': &433 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -66428,15 +68053,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *327 - - *328 - - *424 + - *331 + - *332 + - *428 responses: '200': description: Response content: application/json: - schema: &426 + schema: &430 type: object properties: status: @@ -66463,13 +68088,13 @@ paths: - description - started_at examples: - default: &427 + default: &431 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &428 + '400': &432 description: Bad Request content: application/json: @@ -66480,7 +68105,7 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *423 + '403': *427 '404': *6 '503': *114 x-github: @@ -66505,29 +68130,29 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *327 - - *328 - - *424 + - *331 + - *332 + - *428 responses: '200': description: OK content: application/json: - schema: *426 + schema: *430 examples: - default: *427 + default: *431 '202': description: Accepted content: application/json: - schema: *426 + schema: *430 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *428 + '400': *432 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -66559,9 +68184,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *327 - - *328 - - *424 + - *331 + - *332 + - *428 requestBody: required: false content: @@ -66607,8 +68232,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *428 - '403': *429 + '400': *432 + '403': *433 '404': *6 '422': description: Unprocessable Entity @@ -66632,13 +68257,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *327 - - *328 - - *424 + - *331 + - *332 + - *428 - *19 - *17 - - *430 - - *431 + - *434 + - *435 responses: '200': description: Response @@ -66649,10 +68274,10 @@ paths: items: type: object properties: - ref: *414 - analysis_key: *432 - environment: *433 - category: *434 + ref: *418 + analysis_key: *436 + environment: *437 + category: *438 state: type: - string @@ -66669,7 +68294,7 @@ paths: properties: text: type: string - location: *435 + location: *439 html_url: type: string classifications: @@ -66677,7 +68302,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: *436 + items: *440 examples: default: value: @@ -66714,7 +68339,7 @@ paths: end_column: 50 classifications: - source - '403': *423 + '403': *427 '404': *6 '503': *114 x-github: @@ -66748,25 +68373,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *327 - - *328 - - *412 - - *413 + - *331 + - *332 + - *416 + - *417 - *19 - *17 - - *431 + - *435 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *414 + schema: *418 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &437 + schema: &441 type: string description: An identifier for the upload. examples: @@ -66788,23 +68413,23 @@ paths: application/json: schema: type: array - items: &438 + items: &442 type: object properties: - ref: *414 - commit_sha: &446 + ref: *418 + commit_sha: &450 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *432 + analysis_key: *436 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *434 + category: *438 error: type: string examples: @@ -66829,8 +68454,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *437 - tool: *421 + sarif_id: *441 + tool: *425 deletable: type: boolean warning: @@ -66892,7 +68517,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *423 + '403': *427 '404': *6 '503': *114 x-github: @@ -66928,8 +68553,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -66942,7 +68567,7 @@ paths: description: Response content: application/json: - schema: *438 + schema: *442 examples: response: summary: application/json response @@ -66996,7 +68621,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *423 + '403': *427 '404': *6 '422': description: Response if analysis could not be processed @@ -67083,8 +68708,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -67140,7 +68765,7 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *429 + '403': *433 '404': *6 '503': *114 x-github: @@ -67162,8 +68787,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -67171,7 +68796,7 @@ paths: application/json: schema: type: array - items: &439 + items: &443 title: CodeQL Database description: A CodeQL database. type: object @@ -67283,7 +68908,7 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *423 + '403': *427 '404': *6 '503': *114 x-github: @@ -67312,8 +68937,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - name: language in: path description: The language of the CodeQL database. @@ -67325,7 +68950,7 @@ paths: description: Response content: application/json: - schema: *439 + schema: *443 examples: default: value: @@ -67357,9 +68982,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &473 + '302': &477 description: Found - '403': *423 + '403': *427 '404': *6 '503': *114 x-github: @@ -67381,8 +69006,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *327 - - *328 + - *331 + - *332 - name: language in: path description: The language of the CodeQL database. @@ -67392,7 +69017,7 @@ paths: responses: '204': description: Response - '403': *429 + '403': *433 '404': *6 '503': *114 x-github: @@ -67420,8 +69045,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -67430,7 +69055,7 @@ paths: type: object additionalProperties: false properties: - language: &440 + language: &444 type: string description: The language targeted by the CodeQL query enum: @@ -67510,7 +69135,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &444 + schema: &448 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -67520,7 +69145,7 @@ paths: description: The ID of the variant analysis. controller_repo: *65 actor: *4 - query_language: *440 + query_language: *444 query_pack_url: type: string description: The download url for the query pack. @@ -67568,7 +69193,7 @@ paths: items: type: object properties: - repository: &441 + repository: &445 title: Repository Identifier description: Repository Identifier type: object @@ -67610,7 +69235,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &445 + analysis_status: &449 type: string description: The new status of the CodeQL variant analysis repository task. @@ -67642,7 +69267,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &442 + access_mismatch_repos: &446 type: object properties: repository_count: @@ -67657,7 +69282,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *441 + items: *445 required: - repository_count - repositories @@ -67680,8 +69305,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *442 - over_limit_repos: *442 + no_codeql_db_repos: *446 + over_limit_repos: *446 required: - access_mismatch_repos - not_found_repos @@ -67697,7 +69322,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &443 + value: &447 summary: Default response value: id: 1 @@ -67843,10 +69468,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *443 + value: *447 repository_lists: summary: Response for a successful variant analysis submission - value: *443 + value: *447 '404': *6 '422': description: Unable to process variant analysis submission @@ -67874,8 +69499,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *327 - - *328 + - *331 + - *332 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -67887,9 +69512,9 @@ paths: description: Response content: application/json: - schema: *444 + schema: *448 examples: - default: *443 + default: *447 '404': *6 '503': *114 x-github: @@ -67912,7 +69537,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *327 + - *331 - name: repo in: path description: The name of the controller repository. @@ -67947,7 +69572,7 @@ paths: type: object properties: repository: *65 - analysis_status: *445 + analysis_status: *449 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -68072,8 +69697,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -68183,7 +69808,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *423 + '403': *427 '404': *6 '503': *114 x-github: @@ -68204,8 +69829,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -68299,7 +69924,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *429 + '403': *433 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -68370,8 +69995,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -68379,7 +70004,7 @@ paths: schema: type: object properties: - commit_sha: *446 + commit_sha: *450 ref: type: string description: |- @@ -68439,7 +70064,7 @@ paths: schema: type: object properties: - id: *437 + id: *441 url: type: string description: The REST API URL for checking the status of the upload. @@ -68453,7 +70078,7 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *429 + '403': *433 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -68476,8 +70101,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *327 - - *328 + - *331 + - *332 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -68525,7 +70150,7 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *423 + '403': *427 '404': description: Not Found if the sarif id does not match any upload '503': *114 @@ -68550,8 +70175,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -68632,8 +70257,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *327 - - *328 + - *331 + - *332 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -68761,8 +70386,8 @@ paths: parameters: - *17 - *19 - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -68778,7 +70403,7 @@ paths: type: integer codespaces: type: array - items: *237 + items: *241 examples: default: value: @@ -69076,8 +70701,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -69141,17 +70766,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '400': *14 '401': *23 '403': *27 @@ -69180,8 +70805,8 @@ paths: parameters: - *17 - *19 - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -69245,8 +70870,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -69283,9 +70908,9 @@ paths: type: integer machines: type: array - items: *448 + items: *452 examples: - default: &663 + default: &667 value: total_count: 2 machines: @@ -69325,8 +70950,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *327 - - *328 + - *331 + - *332 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -69413,8 +71038,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *327 - - *328 + - *331 + - *332 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -69483,8 +71108,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -69502,7 +71127,7 @@ paths: type: integer secrets: type: array - items: &452 + items: &456 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -69523,7 +71148,7 @@ paths: - created_at - updated_at examples: - default: *449 + default: *453 headers: Link: *66 x-github: @@ -69546,16 +71171,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *450 + schema: *454 examples: - default: *451 + default: *455 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -69575,17 +71200,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 responses: '200': description: Response content: application/json: - schema: *452 + schema: *456 examples: - default: *453 + default: *457 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69605,8 +71230,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 requestBody: required: true @@ -69659,8 +71284,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 responses: '204': @@ -69689,8 +71314,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *327 - - *328 + - *331 + - *332 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -69728,7 +71353,7 @@ paths: application/json: schema: type: array - items: &454 + items: &458 title: Collaborator description: Collaborator type: object @@ -69921,8 +71546,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *327 - - *328 + - *331 + - *332 - *70 responses: '204': @@ -69969,8 +71594,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *327 - - *328 + - *331 + - *332 - *70 requestBody: required: false @@ -69997,7 +71622,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &524 + schema: &528 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -70225,8 +71850,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *327 - - *328 + - *331 + - *332 - *70 responses: '204': @@ -70258,8 +71883,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *327 - - *328 + - *331 + - *332 - *70 responses: '200': @@ -70280,7 +71905,7 @@ paths: user: anyOf: - type: 'null' - - *454 + - *458 required: - permission - role_name @@ -70334,8 +71959,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -70345,7 +71970,7 @@ paths: application/json: schema: type: array - items: &455 + items: &459 title: Commit Comment description: Commit Comment type: object @@ -70403,7 +72028,7 @@ paths: - created_at - updated_at examples: - default: &460 + default: &464 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -70462,17 +72087,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '200': description: Response content: application/json: - schema: *455 + schema: *459 examples: - default: &461 + default: &465 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -70529,8 +72154,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 requestBody: required: true @@ -70553,7 +72178,7 @@ paths: description: Response content: application/json: - schema: *455 + schema: *459 examples: default: value: @@ -70604,8 +72229,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '204': @@ -70627,8 +72252,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -70655,7 +72280,7 @@ paths: application/json: schema: type: array - items: &456 + items: &460 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -70699,7 +72324,7 @@ paths: - content - created_at examples: - default: &527 + default: &531 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -70744,8 +72369,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 requestBody: required: true @@ -70778,9 +72403,9 @@ paths: description: Reaction exists content: application/json: - schema: *456 + schema: *460 examples: - default: &457 + default: &461 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -70809,9 +72434,9 @@ paths: description: Reaction created content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '422': *15 x-github: githubCloudOnly: false @@ -70833,10 +72458,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *327 - - *328 + - *331 + - *332 - *96 - - &528 + - &532 name: reaction_id description: The unique identifier of the reaction. in: path @@ -70891,8 +72516,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *327 - - *328 + - *331 + - *332 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -70948,9 +72573,9 @@ paths: application/json: schema: type: array - items: *458 + items: *462 examples: - default: &575 + default: &579 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -71044,9 +72669,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *327 - - *328 - - &459 + - *331 + - *332 + - &463 name: commit_sha description: The SHA of the commit. in: path @@ -71118,9 +72743,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *327 - - *328 - - *459 + - *331 + - *332 + - *463 - *17 - *19 responses: @@ -71130,9 +72755,9 @@ paths: application/json: schema: type: array - items: *455 + items: *459 examples: - default: *460 + default: *464 headers: Link: *66 x-github: @@ -71160,9 +72785,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *327 - - *328 - - *459 + - *331 + - *332 + - *463 requestBody: required: true content: @@ -71197,9 +72822,9 @@ paths: description: Response content: application/json: - schema: *455 + schema: *459 examples: - default: *461 + default: *465 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -71227,9 +72852,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *327 - - *328 - - *459 + - *331 + - *332 + - *463 - *17 - *19 responses: @@ -71239,9 +72864,9 @@ paths: application/json: schema: type: array - items: *462 + items: *466 examples: - default: &567 + default: &571 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -71778,11 +73403,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *327 - - *328 + - *331 + - *332 - *19 - *17 - - &463 + - &467 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -71797,9 +73422,9 @@ paths: description: Response content: application/json: - schema: *458 + schema: *462 examples: - default: &555 + default: &559 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -71887,7 +73512,7 @@ paths: schema: type: string examples: - default: &470 + default: &474 value: | diff --git a/testfile b/testfile index 9bdeaeb..912c7ef 100644 @@ -71900,7 +73525,7 @@ paths: schema: type: string examples: - default: &471 + default: &475 value: | From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001 From: Mona Lisa <87831417+monalisa@users.noreply.github.com> @@ -71953,11 +73578,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *327 - - *328 - - *463 - - *464 - - *465 + - *331 + - *332 + - *467 + - *468 + - *469 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -71991,9 +73616,9 @@ paths: type: integer check_runs: type: array - items: *405 + items: *409 examples: - default: *466 + default: *470 headers: Link: *66 x-github: @@ -72018,9 +73643,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *327 - - *328 - - *463 + - *331 + - *332 + - *467 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -72028,7 +73653,7 @@ paths: schema: type: integer example: 1 - - *464 + - *468 - *17 - *19 responses: @@ -72046,7 +73671,7 @@ paths: type: integer check_suites: type: array - items: *409 + items: *413 examples: default: value: @@ -72246,9 +73871,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *327 - - *328 - - *463 + - *331 + - *332 + - *467 - *17 - *19 responses: @@ -72450,9 +74075,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *327 - - *328 - - *463 + - *331 + - *332 + - *467 - *17 - *19 responses: @@ -72462,7 +74087,7 @@ paths: application/json: schema: type: array - items: &643 + items: &647 title: Status description: The status of a commit. type: object @@ -72543,7 +74168,7 @@ paths: site_admin: false headers: Link: *66 - '301': *331 + '301': *335 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72571,8 +74196,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -72605,11 +74230,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *467 + - *471 code_of_conduct_file: anyOf: - type: 'null' - - &468 + - &472 title: Community Health File type: object properties: @@ -72629,19 +74254,19 @@ paths: contributing: anyOf: - type: 'null' - - *468 + - *472 readme: anyOf: - type: 'null' - - *468 + - *472 issue_template: anyOf: - type: 'null' - - *468 + - *472 pull_request_template: anyOf: - type: 'null' - - *468 + - *472 required: - code_of_conduct - code_of_conduct_file @@ -72770,8 +74395,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *327 - - *328 + - *331 + - *332 - *19 - *17 - name: basehead @@ -72819,8 +74444,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *458 - merge_base_commit: *458 + base_commit: *462 + merge_base_commit: *462 status: type: string enum: @@ -72844,10 +74469,10 @@ paths: - 6 commits: type: array - items: *458 + items: *462 files: type: array - items: *469 + items: *473 required: - url - html_url @@ -73093,12 +74718,12 @@ paths: schema: type: string examples: - default: *470 + default: *474 application/vnd.github.patch: schema: type: string examples: - default: *471 + default: *475 '404': *6 '500': *53 '503': *114 @@ -73143,8 +74768,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *327 - - *328 + - *331 + - *332 - name: path description: path parameter in: path @@ -73314,7 +74939,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &472 + response-if-content-is-a-file-github-object: &476 summary: Response if content is a file value: type: file @@ -73451,7 +75076,7 @@ paths: - size - type - url - - &580 + - &584 title: Content File description: Content File type: object @@ -73669,7 +75294,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *472 + response-if-content-is-a-file: *476 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -73738,7 +75363,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *473 + '302': *477 '304': *35 x-github: githubCloudOnly: false @@ -73791,8 +75416,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *327 - - *328 + - *331 + - *332 - name: path description: path parameter in: path @@ -73887,7 +75512,7 @@ paths: description: Response content: application/json: - schema: &474 + schema: &478 title: File Commit description: File Commit type: object @@ -74043,7 +75668,7 @@ paths: description: Response content: application/json: - schema: *474 + schema: *478 examples: example-for-creating-a-file: value: @@ -74097,7 +75722,7 @@ paths: schema: oneOf: - *3 - - &506 + - &510 description: Repository rule violation was detected type: object properties: @@ -74118,7 +75743,7 @@ paths: items: type: object properties: - placeholder_id: &635 + placeholder_id: &639 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -74150,8 +75775,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *327 - - *328 + - *331 + - *332 - name: path description: path parameter in: path @@ -74212,7 +75837,7 @@ paths: description: Response content: application/json: - schema: *474 + schema: *478 examples: default: value: @@ -74267,8 +75892,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *327 - - *328 + - *331 + - *332 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -74392,24 +76017,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *327 - - *328 - - *189 - - *190 - - *191 - - *192 + - *331 + - *332 - *193 + - *194 + - *195 + - *196 + - *197 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *194 - - *475 - - *195 - - *196 - - *197 + - *198 + - *479 + - *199 + - *200 + - *201 - *60 - *45 - *46 @@ -74421,7 +76046,7 @@ paths: application/json: schema: type: array - items: &479 + items: &483 type: object description: A Dependabot alert. properties: @@ -74472,7 +76097,7 @@ paths: - transitive - inconclusive - - security_advisory: *476 + security_advisory: *480 security_vulnerability: *64 url: *174 html_url: *175 @@ -74503,8 +76128,8 @@ paths: dismissal. maxLength: 280 fixed_at: *176 - auto_dismissed_at: *477 - dismissal_request: *478 + auto_dismissed_at: *481 + dismissal_request: *482 assignees: type: array description: The users assigned to this alert. @@ -74759,9 +76384,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *327 - - *328 - - &480 + - *331 + - *332 + - &484 name: alert_number in: path description: |- @@ -74776,7 +76401,7 @@ paths: description: Response content: application/json: - schema: *479 + schema: *483 examples: default: value: @@ -74908,9 +76533,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *327 - - *328 - - *480 + - *331 + - *332 + - *484 requestBody: required: true content: @@ -74966,7 +76591,7 @@ paths: description: Response content: application/json: - schema: *479 + schema: *483 examples: default: value: @@ -75096,8 +76721,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -75115,7 +76740,7 @@ paths: type: integer secrets: type: array - items: &483 + items: &487 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -75169,16 +76794,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *481 + schema: *485 examples: - default: *482 + default: *486 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75198,15 +76823,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 responses: '200': description: Response content: application/json: - schema: *483 + schema: *487 examples: default: value: @@ -75232,8 +76857,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 requestBody: required: true @@ -75286,8 +76911,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *327 - - *328 + - *331 + - *332 - *161 responses: '204': @@ -75310,8 +76935,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *327 - - *328 + - *331 + - *332 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -75485,8 +77110,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -75745,8 +77370,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - name: sbom_uuid in: path required: true @@ -75757,7 +77382,7 @@ paths: '302': description: Redirects to a temporary download URL for the completed SBOM. headers: - Location: *484 + Location: *488 '202': description: SBOM is still being processed, no content is returned. '404': *6 @@ -75778,8 +77403,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '201': description: Response @@ -75817,8 +77442,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -75901,7 +77526,7 @@ paths: - version - url additionalProperties: false - metadata: &485 + metadata: &489 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -75940,7 +77565,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *485 + metadata: *489 resolved: type: object description: A collection of resolved package dependencies. @@ -75954,7 +77579,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *485 + metadata: *489 relationship: type: string description: A notation of whether a dependency is requested @@ -76087,8 +77712,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *327 - - *328 + - *331 + - *332 - name: sha description: The SHA recorded at creation time. in: query @@ -76129,9 +77754,9 @@ paths: application/json: schema: type: array - items: *486 + items: *490 examples: - default: *487 + default: *491 headers: Link: *66 x-github: @@ -76197,8 +77822,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -76280,7 +77905,7 @@ paths: description: Response content: application/json: - schema: *486 + schema: *490 examples: simple-example: summary: Simple example @@ -76353,9 +77978,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *327 - - *328 - - &488 + - *331 + - *332 + - &492 name: deployment_id description: deployment_id parameter in: path @@ -76367,7 +77992,7 @@ paths: description: Response content: application/json: - schema: *486 + schema: *490 examples: default: value: @@ -76432,9 +78057,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *327 - - *328 - - *488 + - *331 + - *332 + - *492 responses: '204': description: Response @@ -76456,9 +78081,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *327 - - *328 - - *488 + - *331 + - *332 + - *492 - *17 - *19 responses: @@ -76468,7 +78093,7 @@ paths: application/json: schema: type: array - items: &489 + items: &493 title: Deployment Status description: The status of a deployment. type: object @@ -76632,9 +78257,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *327 - - *328 - - *488 + - *331 + - *332 + - *492 requestBody: required: true content: @@ -76709,9 +78334,9 @@ paths: description: Response content: application/json: - schema: *489 + schema: *493 examples: - default: &490 + default: &494 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -76767,9 +78392,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *327 - - *328 - - *488 + - *331 + - *332 + - *492 - name: status_id in: path required: true @@ -76780,9 +78405,9 @@ paths: description: Response content: application/json: - schema: *489 + schema: *493 examples: - default: *490 + default: *494 '404': *6 x-github: githubCloudOnly: false @@ -76807,8 +78432,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -76865,8 +78490,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -76884,7 +78509,7 @@ paths: - 5 environments: type: array - items: &492 + items: &496 title: Environment description: Details of a deployment environment type: object @@ -76946,7 +78571,7 @@ paths: type: string examples: - wait_timer - wait_timer: &494 + wait_timer: &498 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -76988,11 +78613,11 @@ paths: items: type: object properties: - type: *491 + type: *495 reviewer: anyOf: - *4 - - *187 + - *191 required: - id - node_id @@ -77015,7 +78640,7 @@ paths: - id - node_id - type - deployment_branch_policy: &495 + deployment_branch_policy: &499 type: - object - 'null' @@ -77132,9 +78757,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *327 - - *328 - - &493 + - *331 + - *332 + - &497 name: environment_name in: path required: true @@ -77147,9 +78772,9 @@ paths: description: Response content: application/json: - schema: *492 + schema: *496 examples: - default: &496 + default: &500 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -77233,9 +78858,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 requestBody: required: false content: @@ -77245,7 +78870,7 @@ paths: - object - 'null' properties: - wait_timer: *494 + wait_timer: *498 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -77264,14 +78889,14 @@ paths: items: type: object properties: - type: *491 + type: *495 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *495 + deployment_branch_policy: *499 additionalProperties: false examples: default: @@ -77291,9 +78916,9 @@ paths: description: Response content: application/json: - schema: *492 + schema: *496 examples: - default: *496 + default: *500 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -77317,9 +78942,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 responses: '204': description: Default response @@ -77344,9 +78969,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 - *17 - *19 responses: @@ -77365,7 +78990,7 @@ paths: - 2 branch_policies: type: array - items: &497 + items: &501 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -77426,9 +79051,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 requestBody: required: true content: @@ -77476,9 +79101,9 @@ paths: description: Response content: application/json: - schema: *497 + schema: *501 examples: - example-wildcard: &498 + example-wildcard: &502 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -77520,10 +79145,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *327 - - *328 - - *493 - - &499 + - *331 + - *332 + - *497 + - &503 name: branch_policy_id in: path required: true @@ -77535,9 +79160,9 @@ paths: description: Response content: application/json: - schema: *497 + schema: *501 examples: - default: *498 + default: *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77556,10 +79181,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *327 - - *328 - - *493 - - *499 + - *331 + - *332 + - *497 + - *503 requestBody: required: true content: @@ -77588,9 +79213,9 @@ paths: description: Response content: application/json: - schema: *497 + schema: *501 examples: - default: *498 + default: *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77609,10 +79234,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *327 - - *328 - - *493 - - *499 + - *331 + - *332 + - *497 + - *503 responses: '204': description: Response @@ -77637,9 +79262,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *493 - - *328 - - *327 + - *497 + - *332 + - *331 responses: '200': description: List of deployment protection rules @@ -77656,7 +79281,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &500 + items: &504 title: Deployment protection rule description: Deployment protection rule type: object @@ -77678,7 +79303,7 @@ paths: for the environment. examples: - true - app: &501 + app: &505 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -77781,9 +79406,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *493 - - *328 - - *327 + - *497 + - *332 + - *331 requestBody: content: application/json: @@ -77804,9 +79429,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *500 + schema: *504 examples: - default: &502 + default: &506 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -77841,9 +79466,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *493 - - *328 - - *327 + - *497 + - *332 + - *331 - *19 - *17 responses: @@ -77863,7 +79488,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *501 + items: *505 examples: default: value: @@ -77898,10 +79523,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *327 - - *328 - - *493 - - &503 + - *331 + - *332 + - *497 + - &507 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -77913,9 +79538,9 @@ paths: description: Response content: application/json: - schema: *500 + schema: *504 examples: - default: *502 + default: *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77936,10 +79561,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *493 - - *328 - - *327 - - *503 + - *497 + - *332 + - *331 + - *507 responses: '204': description: Response @@ -77965,9 +79590,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 - *17 - *19 responses: @@ -77985,9 +79610,9 @@ paths: type: integer secrets: type: array - items: *372 + items: *376 examples: - default: *373 + default: *377 headers: Link: *66 x-github: @@ -78012,17 +79637,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 responses: '200': description: Response content: application/json: - schema: *374 + schema: *378 examples: - default: *375 + default: *379 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78044,18 +79669,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 - *161 responses: '200': description: Response content: application/json: - schema: *372 + schema: *376 examples: - default: *504 + default: *508 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78077,9 +79702,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 - *161 requestBody: required: true @@ -78137,9 +79762,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 - *161 responses: '204': @@ -78165,10 +79790,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *327 - - *328 - - *493 - - *343 + - *331 + - *332 + - *497 + - *347 - *19 responses: '200': @@ -78185,9 +79810,9 @@ paths: type: integer variables: type: array - items: *376 + items: *380 examples: - default: *377 + default: *381 headers: Link: *66 x-github: @@ -78210,9 +79835,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 requestBody: required: true content: @@ -78264,18 +79889,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *327 - - *328 - - *493 + - *331 + - *332 + - *497 - *164 responses: '200': description: Response content: application/json: - schema: *376 + schema: *380 examples: - default: *505 + default: *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78296,10 +79921,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *327 - - *328 + - *331 + - *332 - *164 - - *493 + - *497 requestBody: required: true content: @@ -78341,10 +79966,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *327 - - *328 + - *331 + - *332 - *164 - - *493 + - *497 responses: '204': description: Response @@ -78366,8 +79991,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -78435,8 +80060,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *327 - - *328 + - *331 + - *332 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -78595,8 +80220,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: false content: @@ -78629,9 +80254,9 @@ paths: description: Response content: application/json: - schema: *330 + schema: *334 examples: - default: *332 + default: *336 '400': *14 '422': *15 '403': *27 @@ -78652,8 +80277,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -78713,7 +80338,7 @@ paths: schema: oneOf: - *122 - - *506 + - *510 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78738,8 +80363,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *327 - - *328 + - *331 + - *332 - name: file_sha in: path required: true @@ -78839,8 +80464,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -78949,7 +80574,7 @@ paths: description: Response content: application/json: - schema: &507 + schema: &511 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -79176,15 +80801,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *327 - - *328 - - *459 + - *331 + - *332 + - *463 responses: '200': description: Response content: application/json: - schema: *507 + schema: *511 examples: default: value: @@ -79240,9 +80865,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *327 - - *328 - - &508 + - *331 + - *332 + - &512 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -79259,7 +80884,7 @@ paths: application/json: schema: type: array - items: &509 + items: &513 title: Git Reference description: Git references within a repository type: object @@ -79335,17 +80960,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *327 - - *328 - - *508 + - *331 + - *332 + - *512 responses: '200': description: Response content: application/json: - schema: *509 + schema: *513 examples: - default: &510 + default: &514 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -79374,8 +80999,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -79404,9 +81029,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *513 examples: - default: *510 + default: *514 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -79432,9 +81057,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *327 - - *328 - - *508 + - *331 + - *332 + - *512 requestBody: required: true content: @@ -79463,9 +81088,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *513 examples: - default: *510 + default: *514 '422': *15 '409': *52 x-github: @@ -79483,9 +81108,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *327 - - *328 - - *508 + - *331 + - *332 + - *512 responses: '204': description: Response @@ -79540,8 +81165,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -79608,7 +81233,7 @@ paths: description: Response content: application/json: - schema: &512 + schema: &516 title: Git Tag description: Metadata for a Git tag type: object @@ -79664,7 +81289,7 @@ paths: - sha - type - url - verification: *511 + verification: *515 required: - sha - url @@ -79674,7 +81299,7 @@ paths: - tag - message examples: - default: &513 + default: &517 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -79747,8 +81372,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *327 - - *328 + - *331 + - *332 - name: tag_sha in: path required: true @@ -79759,9 +81384,9 @@ paths: description: Response content: application/json: - schema: *512 + schema: *516 examples: - default: *513 + default: *517 '404': *6 '409': *52 x-github: @@ -79785,8 +81410,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -79860,7 +81485,7 @@ paths: description: Response content: application/json: - schema: &514 + schema: &518 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -79962,8 +81587,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *327 - - *328 + - *331 + - *332 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -79986,7 +81611,7 @@ paths: description: Response content: application/json: - schema: *514 + schema: *518 examples: default-response: summary: Default response @@ -80045,8 +81670,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -80056,7 +81681,7 @@ paths: application/json: schema: type: array - items: &515 + items: &519 title: Webhook description: Webhooks for repositories. type: object @@ -80119,7 +81744,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &750 + last_response: &755 title: Hook Response type: object properties: @@ -80196,8 +81821,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: false content: @@ -80250,9 +81875,9 @@ paths: description: Response content: application/json: - schema: *515 + schema: *519 examples: - default: &516 + default: &520 value: type: Repository id: 12345678 @@ -80300,17 +81925,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 responses: '200': description: Response content: application/json: - schema: *515 + schema: *519 examples: - default: *516 + default: *520 '404': *6 x-github: githubCloudOnly: false @@ -80330,9 +81955,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 requestBody: required: true content: @@ -80377,9 +82002,9 @@ paths: description: Response content: application/json: - schema: *515 + schema: *519 examples: - default: *516 + default: *520 '422': *15 '404': *6 x-github: @@ -80400,9 +82025,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 responses: '204': description: Response @@ -80426,9 +82051,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 responses: '200': description: Response @@ -80455,9 +82080,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 requestBody: required: false content: @@ -80501,12 +82126,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 - *17 - - *206 - - *207 + - *210 + - *211 responses: '200': description: Response @@ -80514,9 +82139,9 @@ paths: application/json: schema: type: array - items: *208 + items: *212 examples: - default: *209 + default: *213 '400': *14 '422': *15 x-github: @@ -80535,18 +82160,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 - *16 responses: '200': description: Response content: application/json: - schema: *210 + schema: *214 examples: - default: *211 + default: *215 '400': *14 '422': *15 x-github: @@ -80565,9 +82190,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 - *16 responses: '202': *37 @@ -80590,9 +82215,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 responses: '204': description: Response @@ -80617,9 +82242,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *327 - - *328 - - *205 + - *331 + - *332 + - *209 responses: '204': description: Response @@ -80642,8 +82267,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response if immutable releases are enabled @@ -80691,8 +82316,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': *59 '409': *52 @@ -80712,8 +82337,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': *59 '409': *52 @@ -80770,14 +82395,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: &517 + schema: &521 title: Import description: A repository import from an external source. type: object @@ -80884,7 +82509,7 @@ paths: - html_url - authors_url examples: - default: &520 + default: &524 value: vcs: subversion use_lfs: true @@ -80900,7 +82525,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &518 + '503': &522 description: Unavailable due to service under maintenance. content: application/json: @@ -80929,8 +82554,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -80978,7 +82603,7 @@ paths: description: Response content: application/json: - schema: *517 + schema: *521 examples: default: value: @@ -81003,7 +82628,7 @@ paths: type: string '422': *15 '404': *6 - '503': *518 + '503': *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81031,8 +82656,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: false content: @@ -81084,7 +82709,7 @@ paths: description: Response content: application/json: - schema: *517 + schema: *521 examples: example-1: summary: Example 1 @@ -81132,7 +82757,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *518 + '503': *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81155,12 +82780,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response - '503': *518 + '503': *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81186,9 +82811,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *327 - - *328 - - &684 + - *331 + - *332 + - &688 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -81202,7 +82827,7 @@ paths: application/json: schema: type: array - items: &519 + items: &523 title: Porter Author description: Porter Author type: object @@ -81256,7 +82881,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *518 + '503': *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81281,8 +82906,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *327 - - *328 + - *331 + - *332 - name: author_id in: path required: true @@ -81312,7 +82937,7 @@ paths: description: Response content: application/json: - schema: *519 + schema: *523 examples: default: value: @@ -81325,7 +82950,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *518 + '503': *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81349,8 +82974,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -81391,7 +83016,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *518 + '503': *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81419,8 +83044,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -81447,11 +83072,11 @@ paths: description: Response content: application/json: - schema: *517 + schema: *521 examples: - default: *520 + default: *524 '422': *15 - '503': *518 + '503': *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81474,8 +83099,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -81483,8 +83108,8 @@ paths: application/json: schema: *20 examples: - default: *521 - '301': *331 + default: *525 + '301': *335 '404': *6 x-github: githubCloudOnly: false @@ -81504,8 +83129,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -81513,12 +83138,12 @@ paths: application/json: schema: anyOf: - - *224 + - *228 - type: object properties: {} additionalProperties: false examples: - default: &523 + default: &527 value: limit: collaborators_only origin: repository @@ -81543,13 +83168,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: application/json: - schema: *522 + schema: *526 examples: default: summary: Example request body @@ -81561,9 +83186,9 @@ paths: description: Response content: application/json: - schema: *224 + schema: *228 examples: - default: *523 + default: *527 '409': description: Response x-github: @@ -81585,8 +83210,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -81609,8 +83234,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -81620,9 +83245,9 @@ paths: application/json: schema: type: array - items: *524 + items: *528 examples: - default: &677 + default: &681 value: - id: 1 repository: @@ -81753,9 +83378,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *327 - - *328 - - *228 + - *331 + - *332 + - *232 requestBody: required: false content: @@ -81784,7 +83409,7 @@ paths: description: Response content: application/json: - schema: *524 + schema: *528 examples: default: value: @@ -81915,9 +83540,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *327 - - *328 - - *228 + - *331 + - *332 + - *232 responses: '204': description: Response @@ -81948,8 +83573,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *327 - - *328 + - *331 + - *332 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -81997,7 +83622,7 @@ paths: required: false schema: type: string - - *235 + - *239 - name: sort description: What to sort results by. in: query @@ -82022,7 +83647,7 @@ paths: type: array items: *82 examples: - default: &533 + default: &537 value: - id: 1 node_id: MDU6SXNzdWUx @@ -82171,7 +83796,7 @@ paths: state_reason: completed headers: Link: *66 - '301': *331 + '301': *335 '422': *15 '404': *6 x-github: @@ -82200,8 +83825,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -82293,7 +83918,7 @@ paths: application/json: schema: *82 examples: - default: &530 + default: &534 value: id: 1 node_id: MDU6SXNzdWUx @@ -82456,7 +84081,7 @@ paths: '422': *15 '503': *114 '404': *6 - '410': *525 + '410': *529 x-github: triggersNotification: true githubCloudOnly: false @@ -82494,8 +84119,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *104 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -82518,7 +84143,7 @@ paths: type: array items: *83 examples: - default: &532 + default: &536 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -82576,8 +84201,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '200': @@ -82586,7 +84211,7 @@ paths: application/json: schema: *83 examples: - default: &526 + default: &530 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -82641,8 +84266,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 requestBody: required: true @@ -82667,7 +84292,7 @@ paths: application/json: schema: *83 examples: - default: *526 + default: *530 '422': *15 x-github: githubCloudOnly: false @@ -82685,8 +84310,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '204': @@ -82715,8 +84340,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#pin-an-issue-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '200': @@ -82779,7 +84404,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *525 + '410': *529 '422': *15 x-github: githubCloudOnly: false @@ -82796,8 +84421,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#unpin-an-issue-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '204': @@ -82805,7 +84430,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *525 + '410': *529 '503': *114 x-github: githubCloudOnly: false @@ -82823,8 +84448,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -82851,9 +84476,9 @@ paths: application/json: schema: type: array - items: *456 + items: *460 examples: - default: *527 + default: *531 headers: Link: *66 '404': *6 @@ -82874,8 +84499,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 requestBody: required: true @@ -82908,16 +84533,16 @@ paths: description: Reaction exists content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '201': description: Reaction created content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '422': *15 x-github: githubCloudOnly: false @@ -82939,10 +84564,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *327 - - *328 + - *331 + - *332 - *96 - - *528 + - *532 responses: '204': description: Response @@ -82962,8 +84587,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -82973,7 +84598,7 @@ paths: application/json: schema: type: array - items: &529 + items: &533 title: Issue Event description: Issue Event type: object @@ -83053,7 +84678,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *187 + requested_team: *191 dismissed_review: title: Issue Event Dismissed Review type: object @@ -83313,8 +84938,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *327 - - *328 + - *331 + - *332 - name: event_id in: path required: true @@ -83325,7 +84950,7 @@ paths: description: Response content: application/json: - schema: *529 + schema: *533 examples: default: value: @@ -83518,7 +85143,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *525 + '410': *529 '403': *27 x-github: githubCloudOnly: false @@ -83552,9 +85177,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *327 - - *328 - - &531 + - *331 + - *332 + - &535 name: issue_number description: The number that identifies the issue. in: path @@ -83570,7 +85195,7 @@ paths: examples: default: summary: Issue - value: *530 + value: *534 pinned_comment: summary: Issue with pinned comment value: @@ -83775,9 +85400,9 @@ paths: - op: remove path: "/value/assignee" version: '2026-03-10' - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 '304': *35 x-github: githubCloudOnly: false @@ -83802,9 +85427,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: false content: @@ -83945,13 +85570,13 @@ paths: application/json: schema: *82 examples: - default: *530 + default: *534 '422': *15 '503': *114 '403': *27 - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83979,9 +85604,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: false content: @@ -84009,7 +85634,7 @@ paths: application/json: schema: *82 examples: - default: *530 + default: *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84025,9 +85650,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: content: application/json: @@ -84054,7 +85679,7 @@ paths: application/json: schema: *82 examples: - default: *530 + default: *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84076,9 +85701,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - name: assignee in: path required: true @@ -84118,9 +85743,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *87 - *17 - *19 @@ -84133,11 +85758,11 @@ paths: type: array items: *83 examples: - default: *532 + default: *536 headers: Link: *66 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84166,9 +85791,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -84192,14 +85817,14 @@ paths: application/json: schema: *83 examples: - default: *526 + default: *530 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *525 + '410': *529 '422': *15 '404': *6 x-github: @@ -84227,9 +85852,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *17 - *19 responses: @@ -84241,12 +85866,12 @@ paths: type: array items: *82 examples: - default: *533 + default: *537 headers: Link: *66 - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84274,9 +85899,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -84300,15 +85925,15 @@ paths: application/json: schema: *82 examples: - default: *530 + default: *534 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *331 + '301': *335 '403': *27 - '410': *525 + '410': *529 '422': *15 '404': *6 x-github: @@ -84339,9 +85964,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -84355,13 +85980,13 @@ paths: application/json: schema: *82 examples: - default: *530 - '301': *331 + default: *534 + '301': *335 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *525 + '410': *529 x-github: triggersNotification: true githubCloudOnly: false @@ -84387,9 +86012,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *17 - *19 responses: @@ -84401,12 +86026,12 @@ paths: type: array items: *82 examples: - default: *533 + default: *537 headers: Link: *66 - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84423,9 +86048,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *17 - *19 responses: @@ -84439,7 +86064,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &537 + - &541 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -84488,7 +86113,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &538 + - &542 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -84616,7 +86241,7 @@ paths: - performed_via_github_app - assignee - assigner - - &539 + - &543 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -84662,7 +86287,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &540 + - &544 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -84708,7 +86333,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &541 + - &545 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -84757,7 +86382,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &542 + - &546 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -84786,7 +86411,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *187 + requested_team: *191 requested_reviewer: *4 required: - review_requester @@ -84799,7 +86424,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &543 + - &547 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -84828,7 +86453,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *187 + requested_team: *191 requested_reviewer: *4 required: - review_requester @@ -84841,7 +86466,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &544 + - &548 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -84897,7 +86522,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &545 + - &549 title: Locked Issue Event description: Locked Issue Event type: object @@ -84942,7 +86567,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &546 + - &550 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -85003,7 +86628,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &547 + - &551 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -85064,7 +86689,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &548 + - &552 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -85125,7 +86750,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &549 + - &553 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -85218,7 +86843,7 @@ paths: color: red headers: Link: *66 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85235,9 +86860,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#list-issue-field-values-for-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *17 - *19 responses: @@ -85247,9 +86872,9 @@ paths: application/json: schema: type: array - items: *534 + items: *538 examples: - default: &535 + default: &539 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -85273,9 +86898,9 @@ paths: value: '2025-12-25' headers: Link: *66 - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85304,9 +86929,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -85372,9 +86997,9 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *534 + items: *538 examples: - default: *535 + default: *539 '400': *14 '403': *27 '404': *6 @@ -85410,9 +87035,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -85479,9 +87104,9 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *534 + items: *538 examples: - default: *535 + default: *539 '400': *14 '403': *27 '404': *6 @@ -85512,10 +87137,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue parameters: - - *327 - - *328 - - *531 - - *231 + - *331 + - *332 + - *535 + - *235 responses: '204': description: Issue field value deleted successfully @@ -85540,9 +87165,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *17 - *19 responses: @@ -85554,7 +87179,7 @@ paths: type: array items: *81 examples: - default: &536 + default: &540 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -85572,9 +87197,9 @@ paths: default: false headers: Link: *66 - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85590,9 +87215,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: false content: @@ -85637,10 +87262,10 @@ paths: type: array items: *81 examples: - default: *536 - '301': *331 + default: *540 + '301': *335 '404': *6 - '410': *525 + '410': *529 '422': *15 x-github: githubCloudOnly: false @@ -85657,9 +87282,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: false content: @@ -85721,10 +87346,10 @@ paths: type: array items: *81 examples: - default: *536 - '301': *331 + default: *540 + '301': *335 '404': *6 - '410': *525 + '410': *529 '422': *15 x-github: githubCloudOnly: false @@ -85741,15 +87366,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 responses: '204': description: Response - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85768,9 +87393,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - name: name in: path required: true @@ -85794,9 +87419,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *331 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85816,9 +87441,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: false content: @@ -85847,7 +87472,7 @@ paths: '204': description: Response '403': *27 - '410': *525 + '410': *529 '404': *6 '422': *15 x-github: @@ -85865,9 +87490,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 responses: '204': description: Response @@ -85897,9 +87522,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 responses: '200': description: Response @@ -85907,10 +87532,10 @@ paths: application/json: schema: *82 examples: - default: *530 - '301': *331 + default: *534 + '301': *335 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85927,9 +87552,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -85955,13 +87580,13 @@ paths: application/json: schema: type: array - items: *456 + items: *460 examples: - default: *527 + default: *531 headers: Link: *66 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85979,9 +87604,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -86013,16 +87638,16 @@ paths: description: Response content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '201': description: Response content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '422': *15 x-github: githubCloudOnly: false @@ -86044,10 +87669,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *327 - - *328 - - *531 - - *528 + - *331 + - *332 + - *535 + - *532 responses: '204': description: Response @@ -86076,9 +87701,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -86102,7 +87727,7 @@ paths: application/json: schema: *82 examples: - default: *530 + default: *534 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -86135,9 +87760,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *17 - *19 responses: @@ -86149,11 +87774,11 @@ paths: type: array items: *82 examples: - default: *533 + default: *537 headers: Link: *66 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86181,9 +87806,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -86212,14 +87837,14 @@ paths: application/json: schema: *82 examples: - default: *530 + default: *534 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *525 + '410': *529 '422': *15 '404': *6 x-github: @@ -86239,9 +87864,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 requestBody: required: true content: @@ -86274,7 +87899,7 @@ paths: application/json: schema: *82 examples: - default: *530 + default: *534 '403': *27 '404': *6 '422': *7 @@ -86296,9 +87921,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *327 - - *328 - - *531 + - *331 + - *332 + - *535 - *17 - *19 responses: @@ -86313,10 +87938,6 @@ paths: description: Timeline Event type: object anyOf: - - *537 - - *538 - - *539 - - *540 - *541 - *542 - *543 @@ -86326,6 +87947,10 @@ paths: - *547 - *548 - *549 + - *550 + - *551 + - *552 + - *553 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -86382,7 +88007,7 @@ paths: pin: anyOf: - type: 'null' - - *550 + - *554 required: - event - actor @@ -86658,7 +88283,7 @@ paths: type: string comments: type: array - items: &569 + items: &573 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -86899,7 +88524,7 @@ paths: type: string comments: type: array - items: *455 + items: *459 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -87174,7 +88799,7 @@ paths: headers: Link: *66 '404': *6 - '410': *525 + '410': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87191,8 +88816,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -87202,7 +88827,7 @@ paths: application/json: schema: type: array - items: &551 + items: &555 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -87270,8 +88895,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -87307,9 +88932,9 @@ paths: description: Response content: application/json: - schema: *551 + schema: *555 examples: - default: &552 + default: &556 value: id: 1 key: ssh-rsa AAA... @@ -87343,9 +88968,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *327 - - *328 - - &553 + - *331 + - *332 + - &557 name: key_id description: The unique identifier of the key. in: path @@ -87357,9 +88982,9 @@ paths: description: Response content: application/json: - schema: *551 + schema: *555 examples: - default: *552 + default: *556 '404': *6 x-github: githubCloudOnly: false @@ -87377,9 +89002,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *327 - - *328 - - *553 + - *331 + - *332 + - *557 responses: '204': description: Response @@ -87399,8 +89024,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -87412,7 +89037,7 @@ paths: type: array items: *81 examples: - default: *536 + default: *540 headers: Link: *66 '404': *6 @@ -87433,8 +89058,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -87472,7 +89097,7 @@ paths: application/json: schema: *81 examples: - default: &554 + default: &558 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -87504,8 +89129,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *327 - - *328 + - *331 + - *332 - name: name in: path required: true @@ -87518,7 +89143,7 @@ paths: application/json: schema: *81 examples: - default: *554 + default: *558 '404': *6 x-github: githubCloudOnly: false @@ -87535,8 +89160,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *327 - - *328 + - *331 + - *332 - name: name in: path required: true @@ -87601,8 +89226,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *327 - - *328 + - *331 + - *332 - name: name in: path required: true @@ -87628,8 +89253,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -87668,9 +89293,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *327 - - *328 - - *430 + - *331 + - *332 + - *434 responses: '200': description: Response @@ -87817,8 +89442,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -87883,8 +89508,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -87918,9 +89543,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *458 + schema: *462 examples: - default: *555 + default: *559 '204': description: Response when already merged '404': @@ -87945,8 +89570,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *327 - - *328 + - *331 + - *332 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -87987,7 +89612,7 @@ paths: application/json: schema: type: array - items: *268 + items: *272 examples: default: value: @@ -88043,8 +89668,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -88084,9 +89709,9 @@ paths: description: Response content: application/json: - schema: *268 + schema: *272 examples: - default: &556 + default: &560 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -88145,9 +89770,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *327 - - *328 - - &557 + - *331 + - *332 + - &561 name: milestone_number description: The number that identifies the milestone. in: path @@ -88159,9 +89784,9 @@ paths: description: Response content: application/json: - schema: *268 + schema: *272 examples: - default: *556 + default: *560 '404': *6 x-github: githubCloudOnly: false @@ -88178,9 +89803,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *327 - - *328 - - *557 + - *331 + - *332 + - *561 requestBody: required: false content: @@ -88218,9 +89843,9 @@ paths: description: Response content: application/json: - schema: *268 + schema: *272 examples: - default: *556 + default: *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88236,9 +89861,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *327 - - *328 - - *557 + - *331 + - *332 + - *561 responses: '204': description: Response @@ -88259,9 +89884,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *327 - - *328 - - *557 + - *331 + - *332 + - *561 - *17 - *19 responses: @@ -88273,7 +89898,7 @@ paths: type: array items: *81 examples: - default: *536 + default: *540 headers: Link: *66 x-github: @@ -88292,12 +89917,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *327 - - *328 - - *558 - - *559 + - *331 + - *332 + - *562 + - *563 - *87 - - *560 + - *564 - *17 - *19 responses: @@ -88309,7 +89934,7 @@ paths: type: array items: *107 examples: - default: *561 + default: *565 headers: Link: *66 x-github: @@ -88333,8 +89958,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: false content: @@ -88392,14 +90017,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: &562 + schema: &566 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -88543,7 +90168,7 @@ paths: - custom_404 - public examples: - default: &563 + default: &567 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -88584,8 +90209,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -88640,9 +90265,9 @@ paths: description: Response content: application/json: - schema: *562 + schema: *566 examples: - default: *563 + default: *567 '422': *15 '409': *52 x-github: @@ -88665,8 +90290,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -88766,8 +90391,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -88793,8 +90418,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -88804,7 +90429,7 @@ paths: application/json: schema: type: array - items: &564 + items: &568 title: Page Build description: Page Build type: object @@ -88896,8 +90521,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *327 - - *328 + - *331 + - *332 responses: '201': description: Response @@ -88944,16 +90569,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *564 + schema: *568 examples: - default: &565 + default: &569 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -89001,8 +90626,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *327 - - *328 + - *331 + - *332 - name: build_id in: path required: true @@ -89013,9 +90638,9 @@ paths: description: Response content: application/json: - schema: *564 + schema: *568 examples: - default: *565 + default: *569 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89035,8 +90660,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -89144,9 +90769,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *327 - - *328 - - &566 + - *331 + - *332 + - &570 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -89204,9 +90829,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *327 - - *328 - - *566 + - *331 + - *332 + - *570 responses: '204': *59 '404': *6 @@ -89233,8 +90858,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -89529,8 +91154,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Private vulnerability reporting status @@ -89567,8 +91192,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': *59 '422': *14 @@ -89589,8 +91214,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': *59 '422': *14 @@ -89612,8 +91237,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -89621,7 +91246,7 @@ paths: application/json: schema: type: array - items: *282 + items: *286 examples: default: value: @@ -89652,8 +91277,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -89665,7 +91290,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *282 + items: *286 required: - properties examples: @@ -89715,8 +91340,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *327 - - *328 + - *331 + - *332 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -89776,9 +91401,9 @@ paths: application/json: schema: type: array - items: *462 + items: *466 examples: - default: *567 + default: *571 headers: Link: *66 '304': *35 @@ -89810,8 +91435,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -89878,7 +91503,7 @@ paths: description: Response content: application/json: - schema: &571 + schema: &575 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -90007,7 +91632,7 @@ paths: milestone: anyOf: - type: 'null' - - *268 + - *272 active_lock_reason: type: - string @@ -90056,7 +91681,7 @@ paths: items: *4 requested_teams: type: array - items: *247 + items: *251 head: type: object properties: @@ -90094,14 +91719,14 @@ paths: _links: type: object properties: - comments: *269 - commits: *269 - statuses: *269 - html: *269 - issue: *269 - review_comments: *269 - review_comment: *269 - self: *269 + comments: *273 + commits: *273 + statuses: *273 + html: *273 + issue: *273 + review_comments: *273 + review_comment: *273 + self: *273 required: - comments - commits @@ -90112,7 +91737,7 @@ paths: - review_comment - self author_association: *79 - auto_merge: *568 + auto_merge: *572 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -90308,7 +91933,7 @@ paths: - review_comments version: '2026-03-10' examples: - default: &572 + default: &576 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -90846,8 +92471,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *327 - - *328 + - *331 + - *332 - name: sort in: query required: false @@ -90876,9 +92501,9 @@ paths: application/json: schema: type: array - items: *569 + items: *573 examples: - default: &574 + default: &578 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -90955,17 +92580,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '200': description: Response content: application/json: - schema: *569 + schema: *573 examples: - default: &570 + default: &574 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -91040,8 +92665,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 + - *331 + - *332 - *96 requestBody: required: true @@ -91064,9 +92689,9 @@ paths: description: Response content: application/json: - schema: *569 + schema: *573 examples: - default: *570 + default: *574 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91082,8 +92707,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 + - *331 + - *332 - *96 responses: '204': @@ -91105,8 +92730,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -91133,9 +92758,9 @@ paths: application/json: schema: type: array - items: *456 + items: *460 examples: - default: *527 + default: *531 headers: Link: *66 '404': *6 @@ -91156,8 +92781,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *327 - - *328 + - *331 + - *332 - *96 requestBody: required: true @@ -91190,16 +92815,16 @@ paths: description: Reaction exists content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '201': description: Reaction created content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '422': *15 x-github: githubCloudOnly: false @@ -91221,10 +92846,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *327 - - *328 + - *331 + - *332 - *96 - - *528 + - *532 responses: '204': description: Response @@ -91267,9 +92892,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *327 - - *328 - - &573 + - *331 + - *332 + - &577 name: pull_number description: The number that identifies the pull request. in: path @@ -91282,9 +92907,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *571 + schema: *575 examples: - default: *572 + default: *576 '304': *35 '404': *6 '406': @@ -91319,9 +92944,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: false content: @@ -91363,9 +92988,9 @@ paths: description: Response content: application/json: - schema: *571 + schema: *575 examples: - default: *572 + default: *576 '422': *15 '403': *27 x-github: @@ -91387,9 +93012,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 responses: '204': description: Response @@ -91414,9 +93039,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 responses: '204': description: Response @@ -91442,9 +93067,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: true content: @@ -91505,17 +93130,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '401': *23 '403': *27 '404': *6 @@ -91545,9 +93170,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 - *104 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -91568,9 +93193,9 @@ paths: application/json: schema: type: array - items: *569 + items: *573 examples: - default: *574 + default: *578 headers: Link: *66 x-github: @@ -91603,9 +93228,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: true content: @@ -91711,7 +93336,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *573 examples: example-for-a-multi-line-comment: value: @@ -91799,9 +93424,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 - *96 requestBody: required: true @@ -91824,7 +93449,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *573 examples: default: value: @@ -91910,9 +93535,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 - *17 - *19 responses: @@ -91922,9 +93547,9 @@ paths: application/json: schema: type: array - items: *458 + items: *462 examples: - default: *575 + default: *579 headers: Link: *66 x-github: @@ -91954,9 +93579,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 - *17 - *19 responses: @@ -91966,7 +93591,7 @@ paths: application/json: schema: type: array - items: *469 + items: *473 examples: default: value: @@ -92004,9 +93629,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 responses: '204': description: Response if pull request has been merged @@ -92029,9 +93654,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: false content: @@ -92143,9 +93768,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 responses: '200': description: Response @@ -92161,7 +93786,7 @@ paths: items: *4 teams: type: array - items: *187 + items: *191 required: - users - teams @@ -92220,9 +93845,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: false content: @@ -92259,7 +93884,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *466 examples: default: value: @@ -92795,9 +94420,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: true content: @@ -92831,7 +94456,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *466 examples: default: value: @@ -93347,9 +94972,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 - *17 - *19 responses: @@ -93359,7 +94984,7 @@ paths: application/json: schema: type: array - items: &576 + items: &580 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -93515,9 +95140,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: false content: @@ -93607,9 +95232,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: - default: &578 + default: &582 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -93672,10 +95297,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 - - &577 + - *331 + - *332 + - *577 + - &581 name: review_id description: The unique identifier of the review. in: path @@ -93687,9 +95312,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: - default: &579 + default: &583 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -93748,10 +95373,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 - *577 + - *581 requestBody: required: true content: @@ -93774,7 +95399,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: default: value: @@ -93836,18 +95461,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 - *577 + - *581 responses: '200': description: Response content: application/json: - schema: *576 + schema: *580 examples: - default: *578 + default: *582 '422': *7 '404': *6 x-github: @@ -93874,10 +95499,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *327 - - *328 - - *573 + - *331 + - *332 - *577 + - *581 - *17 - *19 responses: @@ -93975,9 +95600,9 @@ paths: _links: type: object properties: - self: *269 - html: *269 - pull_request: *269 + self: *273 + html: *273 + pull_request: *273 required: - self - html @@ -94135,10 +95760,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 - *577 + - *581 requestBody: required: true content: @@ -94167,7 +95792,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: default: value: @@ -94230,10 +95855,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *331 + - *332 - *577 + - *581 requestBody: required: true content: @@ -94268,9 +95893,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: - default: *579 + default: *583 '404': *6 '422': *7 '403': *27 @@ -94292,9 +95917,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *327 - - *328 - - *573 + - *331 + - *332 + - *577 requestBody: required: false content: @@ -94358,8 +95983,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *327 - - *328 + - *331 + - *332 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -94372,9 +95997,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *584 examples: - default: &581 + default: &585 value: type: file encoding: base64 @@ -94416,8 +96041,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *327 - - *328 + - *331 + - *332 - name: dir description: The alternate path to look for a README file in: path @@ -94437,9 +96062,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *584 examples: - default: *581 + default: *585 '404': *6 '422': *15 x-github: @@ -94461,8 +96086,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -94472,7 +96097,7 @@ paths: application/json: schema: type: array - items: *582 + items: *586 examples: default: value: @@ -94566,8 +96191,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -94643,9 +96268,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *586 examples: - default: &586 + default: &590 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -94750,9 +96375,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *327 - - *328 - - &584 + - *331 + - *332 + - &588 name: asset_id description: The unique identifier of the asset. in: path @@ -94764,9 +96389,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *587 examples: - default: &585 + default: &589 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -94801,7 +96426,7 @@ paths: type: User site_admin: false '404': *6 - '302': *473 + '302': *477 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94817,9 +96442,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *327 - - *328 - - *584 + - *331 + - *332 + - *588 requestBody: required: false content: @@ -94848,9 +96473,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *587 examples: - default: *585 + default: *589 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94866,9 +96491,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *327 - - *328 - - *584 + - *331 + - *332 + - *588 responses: '204': description: Response @@ -94893,8 +96518,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -94980,16 +96605,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response content: application/json: - schema: *582 + schema: *586 examples: - default: *586 + default: *590 '404': *6 x-github: githubCloudOnly: false @@ -95007,8 +96632,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *327 - - *328 + - *331 + - *332 - name: tag description: tag parameter in: path @@ -95021,9 +96646,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *586 examples: - default: *586 + default: *590 '404': *6 x-github: githubCloudOnly: false @@ -95045,9 +96670,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *327 - - *328 - - &587 + - *331 + - *332 + - &591 name: release_id description: The unique identifier of the release. in: path @@ -95061,9 +96686,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *582 + schema: *586 examples: - default: *586 + default: *590 '401': description: Unauthorized x-github: @@ -95081,9 +96706,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *327 - - *328 - - *587 + - *331 + - *332 + - *591 requestBody: required: false content: @@ -95147,9 +96772,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *586 examples: - default: *586 + default: *590 '404': description: Not Found if the discussion category name is invalid content: @@ -95170,9 +96795,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *327 - - *328 - - *587 + - *331 + - *332 + - *591 responses: '204': description: Response @@ -95193,9 +96818,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *327 - - *328 - - *587 + - *331 + - *332 + - *591 - *17 - *19 responses: @@ -95205,7 +96830,7 @@ paths: application/json: schema: type: array - items: *583 + items: *587 examples: default: value: @@ -95286,9 +96911,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *327 - - *328 - - *587 + - *331 + - *332 + - *591 - name: name in: query required: true @@ -95314,7 +96939,7 @@ paths: description: Response for successful upload content: application/json: - schema: *583 + schema: *587 examples: response-for-successful-upload: value: @@ -95369,9 +96994,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *327 - - *328 - - *587 + - *331 + - *332 + - *591 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -95395,9 +97020,9 @@ paths: application/json: schema: type: array - items: *456 + items: *460 examples: - default: *527 + default: *531 headers: Link: *66 '404': *6 @@ -95418,9 +97043,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *327 - - *328 - - *587 + - *331 + - *332 + - *591 requestBody: required: true content: @@ -95450,16 +97075,16 @@ paths: description: Reaction exists content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '201': description: Reaction created content: application/json: - schema: *456 + schema: *460 examples: - default: *457 + default: *461 '422': *15 x-github: githubCloudOnly: false @@ -95481,10 +97106,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *327 - - *328 - - *587 - - *528 + - *331 + - *332 + - *591 + - *532 responses: '204': description: Response @@ -95508,9 +97133,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *327 - - *328 - - *394 + - *331 + - *332 + - *398 - *17 - *19 responses: @@ -95526,8 +97151,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *289 - - &588 + - *293 + - &592 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -95546,69 +97171,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *290 - - *588 - - allOf: - - *291 - - *588 - - allOf: - - *292 - - *588 - - allOf: - - *589 - - *588 - - allOf: - - *293 - - *588 - allOf: - *294 - - *588 + - *592 - allOf: - *295 - - *588 + - *592 - allOf: - *296 - - *588 + - *592 + - allOf: + - *593 + - *592 - allOf: - *297 - - *588 + - *592 - allOf: - *298 - - *588 + - *592 - allOf: - *299 - - *588 + - *592 - allOf: - *300 - - *588 + - *592 - allOf: - *301 - - *588 + - *592 - allOf: - *302 - - *588 + - *592 - allOf: - *303 - - *588 + - *592 - allOf: - *304 - - *588 + - *592 - allOf: - *305 - - *588 + - *592 - allOf: - *306 - - *588 + - *592 - allOf: - *307 - - *588 + - *592 - allOf: - *308 - - *588 + - *592 - allOf: - *309 - - *588 + - *592 + - allOf: + - *310 + - *592 + - allOf: + - *311 + - *592 + - allOf: + - *312 + - *592 + - allOf: + - *313 + - *592 examples: default: value: @@ -95647,8 +97272,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 - name: includes_parents @@ -95659,7 +97284,7 @@ paths: schema: type: boolean default: true - - *590 + - *594 responses: '200': description: Response @@ -95667,7 +97292,7 @@ paths: application/json: schema: type: array - items: *310 + items: *314 examples: default: value: @@ -95714,8 +97339,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *331 + - *332 requestBody: description: Request body required: true @@ -95735,16 +97360,16 @@ paths: - tag - push default: branch - enforcement: *286 + enforcement: *290 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *287 - conditions: *284 + items: *291 + conditions: *288 rules: type: array description: An array of rules within the ruleset. - items: *591 + items: *595 required: - name - enforcement @@ -95775,9 +97400,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *314 examples: - default: &601 + default: &605 value: id: 42 name: super cool ruleset @@ -95825,12 +97450,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *327 - - *328 - - *592 - - *593 - - *594 - - *595 + - *331 + - *332 + - *596 + - *597 + - *598 + - *599 - *17 - *19 responses: @@ -95838,9 +97463,9 @@ paths: description: Response content: application/json: - schema: *596 + schema: *600 examples: - default: *597 + default: *601 '404': *6 '500': *53 x-github: @@ -95861,17 +97486,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *327 - - *328 - - *598 + - *331 + - *332 + - *602 responses: '200': description: Response content: application/json: - schema: *599 + schema: *603 examples: - default: *600 + default: *604 '404': *6 '500': *53 x-github: @@ -95899,8 +97524,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *331 + - *332 - name: ruleset_id description: The ID of the ruleset. in: path @@ -95920,9 +97545,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *314 examples: - default: *601 + default: *605 '404': *6 '500': *53 put: @@ -95940,8 +97565,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *331 + - *332 - name: ruleset_id description: The ID of the ruleset. in: path @@ -95966,16 +97591,16 @@ paths: - branch - tag - push - enforcement: *286 + enforcement: *290 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *287 - conditions: *284 + items: *291 + conditions: *288 rules: description: An array of rules within the ruleset. type: array - items: *591 + items: *595 examples: default: value: @@ -96003,9 +97628,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *314 examples: - default: *601 + default: *605 '404': *6 '422': *15 '500': *53 @@ -96024,8 +97649,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *331 + - *332 - name: ruleset_id description: The ID of the ruleset. in: path @@ -96048,8 +97673,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 - name: ruleset_id @@ -96065,9 +97690,9 @@ paths: application/json: schema: type: array - items: *313 + items: *317 examples: - default: *602 + default: *606 '404': *6 '500': *53 x-github: @@ -96086,8 +97711,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *327 - - *328 + - *331 + - *332 - name: ruleset_id description: The ID of the ruleset. in: path @@ -96105,7 +97730,7 @@ paths: description: Response content: application/json: - schema: *603 + schema: *607 examples: default: value: @@ -96160,25 +97785,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *327 - - *328 - - *604 - - *605 - - *606 - - *607 + - *331 + - *332 - *608 - *609 - *610 - *611 - - *60 - - *19 - - *17 - *612 - *613 - *614 - *615 + - *60 + - *19 + - *17 - *616 - *617 + - *618 + - *619 + - *620 + - *621 responses: '200': description: Response @@ -96186,7 +97811,7 @@ paths: application/json: schema: type: array - items: &621 + items: &625 type: object properties: number: *171 @@ -96202,8 +97827,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *618 - resolution: *619 + state: *622 + resolution: *623 resolved_at: type: - string @@ -96309,7 +97934,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *620 + - *624 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -96468,16 +98093,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *327 - - *328 - - *424 - - *617 + - *331 + - *332 + - *428 + - *621 responses: '200': description: Response content: application/json: - schema: *621 + schema: *625 examples: default: value: @@ -96531,9 +98156,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *327 - - *328 - - *424 + - *331 + - *332 + - *428 requestBody: required: true content: @@ -96541,8 +98166,8 @@ paths: schema: type: object properties: - state: *618 - resolution: *619 + state: *622 + resolution: *623 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -96555,6 +98180,16 @@ paths: type: - string - 'null' + validity: + type: + - string + - 'null' + enum: + - active + - inactive + - + description: Sets the validity of the secret scanning alert. Can + be `active`, `inactive`, or `null` to clear the override. anyOf: - required: - state @@ -96580,7 +98215,7 @@ paths: description: Response content: application/json: - schema: *621 + schema: *625 examples: default: value: @@ -96652,7 +98287,8 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment, - or assignee does not have write access to the repository + assignee does not have write access to the repository, or the requested + validity change could not be applied to this alert '503': *114 x-github: enabledForGitHubApps: true @@ -96675,9 +98311,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *327 - - *328 - - *424 + - *331 + - *332 + - *428 - *19 - *17 responses: @@ -96688,7 +98324,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &770 + items: &775 type: object properties: type: @@ -96715,10 +98351,6 @@ paths: - commit details: oneOf: - - *622 - - *623 - - *624 - - *625 - *626 - *627 - *628 @@ -96728,6 +98360,10 @@ paths: - *632 - *633 - *634 + - *635 + - *636 + - *637 + - *638 examples: default: value: @@ -96813,8 +98449,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -96822,14 +98458,14 @@ paths: schema: type: object properties: - reason: &636 + reason: &640 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *635 + placeholder_id: *639 required: - reason - placeholder_id @@ -96846,7 +98482,7 @@ paths: schema: type: object properties: - reason: *636 + reason: *640 expire_at: type: - string @@ -96893,8 +98529,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -96909,7 +98545,7 @@ paths: properties: incremental_scans: type: array - items: &637 + items: &641 description: Information on a single scan performed by secret scanning on the repository type: object @@ -96937,15 +98573,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *637 + items: *641 backfill_scans: type: array - items: *637 + items: *641 custom_pattern_backfill_scans: type: array items: allOf: - - *637 + - *641 - type: object properties: pattern_name: @@ -96958,7 +98594,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *637 + items: *641 examples: default: value: @@ -97023,8 +98659,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *327 - - *328 + - *331 + - *332 - *60 - name: sort description: The property to sort the results by. @@ -97068,9 +98704,9 @@ paths: application/json: schema: type: array - items: *638 + items: *642 examples: - default: *639 + default: *643 '400': *14 '404': *6 x-github: @@ -97093,8 +98729,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -97174,7 +98810,7 @@ paths: login: type: string description: The username of the user credited. - type: *316 + type: *320 required: - login - type @@ -97264,9 +98900,9 @@ paths: description: Response content: application/json: - schema: *638 + schema: *642 examples: - default: &641 + default: &645 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -97505,8 +99141,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -97619,7 +99255,7 @@ paths: description: Response content: application/json: - schema: *638 + schema: *642 examples: default: value: @@ -97772,17 +99408,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *327 - - *328 - - *640 + - *331 + - *332 + - *644 responses: '200': description: Response content: application/json: - schema: *638 + schema: *642 examples: - default: *641 + default: *645 '403': *27 '404': *6 x-github: @@ -97806,9 +99442,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *327 - - *328 - - *640 + - *331 + - *332 + - *644 requestBody: required: true content: @@ -97888,7 +99524,7 @@ paths: login: type: string description: The username of the user credited. - type: *316 + type: *320 required: - login - type @@ -97979,10 +99615,10 @@ paths: description: Response content: application/json: - schema: *638 + schema: *642 examples: - default: *641 - add_credit: *641 + default: *645 + add_credit: *645 '403': *27 '404': *6 '422': @@ -98020,9 +99656,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *327 - - *328 - - *640 + - *331 + - *332 + - *644 responses: '202': *37 '400': *14 @@ -98049,17 +99685,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *327 - - *328 - - *640 + - *331 + - *332 + - *644 responses: '202': description: Response content: application/json: - schema: *330 + schema: *334 examples: - default: *332 + default: *336 '400': *14 '422': *15 '403': *27 @@ -98085,8 +99721,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -98182,8 +99818,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -98192,7 +99828,7 @@ paths: application/json: schema: type: array - items: &642 + items: &646 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -98225,8 +99861,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -98304,8 +99940,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -98399,8 +100035,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -98554,8 +100190,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -98565,7 +100201,7 @@ paths: application/json: schema: type: array - items: *642 + items: *646 examples: default: value: @@ -98598,8 +100234,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *327 - - *328 + - *331 + - *332 - name: sha in: path required: true @@ -98655,7 +100291,7 @@ paths: description: Response content: application/json: - schema: *643 + schema: *647 examples: default: value: @@ -98709,8 +100345,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -98742,14 +100378,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &644 + schema: &648 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -98822,8 +100458,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: false content: @@ -98849,7 +100485,7 @@ paths: description: Response content: application/json: - schema: *644 + schema: *648 examples: default: value: @@ -98876,8 +100512,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -98897,8 +100533,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -98980,8 +100616,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *327 - - *328 + - *331 + - *332 - name: ref in: path required: true @@ -99017,8 +100653,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *327 - - *328 + - *331 + - *332 - *17 - *19 responses: @@ -99028,9 +100664,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - default: *248 + default: *252 headers: Link: *66 '404': *6 @@ -99050,8 +100686,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *327 - - *328 + - *331 + - *332 - *19 - *17 responses: @@ -99059,7 +100695,7 @@ paths: description: Response content: application/json: - schema: &645 + schema: &649 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -99071,7 +100707,7 @@ paths: required: - names examples: - default: &646 + default: &650 value: names: - octocat @@ -99094,8 +100730,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -99126,9 +100762,9 @@ paths: description: Response content: application/json: - schema: *645 + schema: *649 examples: - default: *646 + default: *650 '404': *6 '422': *7 x-github: @@ -99149,9 +100785,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *327 - - *328 - - &647 + - *331 + - *332 + - &651 name: per description: The time frame to display results for. in: query @@ -99182,7 +100818,7 @@ paths: - 128 clones: type: array - items: &648 + items: &652 title: Traffic type: object properties: @@ -99269,8 +100905,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -99364,8 +101000,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *327 - - *328 + - *331 + - *332 responses: '200': description: Response @@ -99428,9 +101064,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *327 - - *328 - - *647 + - *331 + - *332 + - *651 responses: '200': description: Response @@ -99451,7 +101087,7 @@ paths: - 3782 views: type: array - items: *648 + items: *652 required: - uniques - count @@ -99528,8 +101164,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *327 - - *328 + - *331 + - *332 requestBody: required: true content: @@ -99809,8 +101445,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -99833,8 +101469,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -99856,8 +101492,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -99883,8 +101519,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *327 - - *328 + - *331 + - *332 - name: ref in: path required: true @@ -99976,9 +101612,9 @@ paths: description: Response content: application/json: - schema: *330 + schema: *334 examples: - default: *332 + default: *336 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -100230,7 +101866,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &649 + text_matches: &653 title: Search Result Text Matches type: array items: @@ -100393,7 +102029,7 @@ paths: enum: - author-date - committer-date - - &650 + - &654 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -100462,7 +102098,7 @@ paths: committer: anyOf: - type: 'null' - - *392 + - *396 comment_count: type: integer message: @@ -100481,7 +102117,7 @@ paths: url: type: string format: uri - verification: *511 + verification: *515 required: - author - committer @@ -100496,7 +102132,7 @@ paths: committer: anyOf: - type: 'null' - - *392 + - *396 parents: type: array items: @@ -100513,7 +102149,7 @@ paths: type: number node_id: type: string - text_matches: *649 + text_matches: *653 required: - sha - node_id @@ -100705,7 +102341,7 @@ paths: - interactions - created - updated - - *650 + - *654 - *17 - *19 - name: advanced_search @@ -100819,11 +102455,11 @@ paths: type: - string - 'null' - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: type: string state_reason: @@ -100837,7 +102473,7 @@ paths: milestone: anyOf: - type: 'null' - - *268 + - *272 comments: type: integer created_at: @@ -100851,7 +102487,7 @@ paths: - string - 'null' format: date-time - text_matches: *649 + text_matches: *653 pull_request: type: object properties: @@ -100900,7 +102536,7 @@ paths: timeline_url: type: string format: uri - type: *232 + type: *236 performed_via_github_app: anyOf: - type: 'null' @@ -101151,7 +102787,7 @@ paths: enum: - created - updated - - *650 + - *654 - *17 - *19 responses: @@ -101196,7 +102832,7 @@ paths: - 'null' score: type: number - text_matches: *649 + text_matches: *653 required: - id - node_id @@ -101281,7 +102917,7 @@ paths: - forks - help-wanted-issues - updated - - *650 + - *654 - *17 - *19 responses: @@ -101527,7 +103163,7 @@ paths: - admin - pull - push - text_matches: *649 + text_matches: *653 temp_clone_token: type: string allow_merge_commit: @@ -101835,7 +103471,7 @@ paths: - string - 'null' format: uri - text_matches: *649 + text_matches: *653 related: type: - array @@ -102028,7 +103664,7 @@ paths: - followers - repositories - joined - - *650 + - *654 - *17 - *19 responses: @@ -102138,7 +103774,7 @@ paths: type: - boolean - 'null' - text_matches: *649 + text_matches: *653 blog: type: - string @@ -102220,7 +103856,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &653 + - &657 name: team_id description: The unique identifier of the team. in: path @@ -102232,9 +103868,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '404': *6 x-github: githubCloudOnly: false @@ -102261,7 +103897,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *653 + - *657 requestBody: required: true content: @@ -102325,16 +103961,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '201': description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '404': *6 '422': *15 '403': *27 @@ -102362,7 +103998,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *653 + - *657 responses: '204': description: Response @@ -102391,7 +104027,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *653 + - *657 - *17 - *19 responses: @@ -102401,9 +104037,9 @@ paths: application/json: schema: type: array - items: *226 + items: *230 examples: - default: *227 + default: *231 headers: Link: *66 x-github: @@ -102429,7 +104065,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *653 + - *657 - name: role description: Filters members returned by their role in the team. in: query @@ -102480,7 +104116,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *653 + - *657 - *70 responses: '204': @@ -102517,7 +104153,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *653 + - *657 - *70 responses: '204': @@ -102557,7 +104193,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *653 + - *657 - *70 responses: '204': @@ -102594,16 +104230,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *653 + - *657 - *70 responses: '200': description: Response content: application/json: - schema: *326 + schema: *330 examples: - response-if-user-is-a-team-maintainer: *654 + response-if-user-is-a-team-maintainer: *658 '404': *6 x-github: githubCloudOnly: false @@ -102636,7 +104272,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *653 + - *657 - *70 requestBody: required: false @@ -102662,9 +104298,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *330 examples: - response-if-users-membership-with-team-is-now-pending: *655 + response-if-users-membership-with-team-is-now-pending: *659 '403': description: Forbidden if team synchronization is set up '422': @@ -102698,7 +104334,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *653 + - *657 - *70 responses: '204': @@ -102726,7 +104362,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *653 + - *657 - *17 - *19 responses: @@ -102738,7 +104374,7 @@ paths: type: array items: *153 examples: - default: *255 + default: *259 headers: Link: *66 '404': *6 @@ -102768,15 +104404,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *653 - - *327 - - *328 + - *657 + - *331 + - *332 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *656 + schema: *660 examples: alternative-response-with-extra-repository-information: value: @@ -102933,9 +104569,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *653 - - *327 - - *328 + - *657 + - *331 + - *332 requestBody: required: false content: @@ -102985,9 +104621,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *653 - - *327 - - *328 + - *657 + - *331 + - *332 responses: '204': description: Response @@ -103012,7 +104648,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *653 + - *657 - *17 - *19 responses: @@ -103022,9 +104658,9 @@ paths: application/json: schema: type: array - items: *187 + items: *191 examples: - response-if-child-teams-exist: *657 + response-if-child-teams-exist: *661 headers: Link: *66 '404': *6 @@ -103057,7 +104693,7 @@ paths: application/json: schema: oneOf: - - &659 + - &663 title: Private User description: Private User type: object @@ -103307,7 +104943,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *658 + - *662 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -103467,7 +105103,7 @@ paths: description: Response content: application/json: - schema: *659 + schema: *663 examples: default: value: @@ -103670,9 +105306,9 @@ paths: type: integer codespaces: type: array - items: *237 + items: *241 examples: - default: *238 + default: *242 '304': *35 '500': *53 '401': *23 @@ -103811,17 +105447,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '401': *23 '403': *27 '404': *6 @@ -103865,7 +105501,7 @@ paths: type: integer secrets: type: array - items: &660 + items: &664 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -103907,7 +105543,7 @@ paths: - visibility - selected_repositories_url examples: - default: *449 + default: *453 headers: Link: *66 x-github: @@ -103985,7 +105621,7 @@ paths: description: Response content: application/json: - schema: *660 + schema: *664 examples: default: value: @@ -104131,7 +105767,7 @@ paths: type: array items: *153 examples: - default: *188 + default: *192 '401': *23 '403': *27 '404': *6 @@ -104275,15 +105911,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *239 + - *243 responses: '200': description: Response content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '304': *35 '500': *53 '401': *23 @@ -104309,7 +105945,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *239 + - *243 requestBody: required: false content: @@ -104339,9 +105975,9 @@ paths: description: Response content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '401': *23 '403': *27 '404': *6 @@ -104363,7 +105999,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *239 + - *243 responses: '202': *37 '304': *35 @@ -104392,13 +106028,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *239 + - *243 responses: '202': description: Response content: application/json: - schema: &661 + schema: &665 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -104451,7 +106087,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &662 + default: &666 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -104483,7 +106119,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *239 + - *243 - name: export_id in: path required: true @@ -104496,9 +106132,9 @@ paths: description: Response content: application/json: - schema: *661 + schema: *665 examples: - default: *662 + default: *666 '404': *6 x-github: githubCloudOnly: false @@ -104519,7 +106155,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *239 + - *243 responses: '200': description: Response @@ -104535,9 +106171,9 @@ paths: type: integer machines: type: array - items: *448 + items: *452 examples: - default: *663 + default: *667 '304': *35 '500': *53 '401': *23 @@ -104566,7 +106202,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *239 + - *243 requestBody: required: true content: @@ -104622,11 +106258,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *330 + repository: *334 machine: anyOf: - type: 'null' - - *448 + - *452 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -105423,15 +107059,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *239 + - *243 responses: '200': description: Response content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '304': *35 '500': *53 '400': *14 @@ -105463,15 +107099,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *239 + - *243 responses: '200': description: Response content: application/json: - schema: *237 + schema: *241 examples: - default: *447 + default: *451 '500': *53 '401': *23 '403': *27 @@ -105501,9 +107137,9 @@ paths: application/json: schema: type: array - items: *249 + items: *253 examples: - default: &674 + default: &678 value: - id: 197 name: hello_docker @@ -105604,7 +107240,7 @@ paths: application/json: schema: type: array - items: &664 + items: &668 title: Email description: Email type: object @@ -105674,9 +107310,9 @@ paths: application/json: schema: type: array - items: *664 + items: *668 examples: - default: &676 + default: &680 value: - email: octocat@github.com verified: true @@ -105753,7 +107389,7 @@ paths: application/json: schema: type: array - items: *664 + items: *668 examples: default: value: @@ -106011,7 +107647,7 @@ paths: application/json: schema: type: array - items: &665 + items: &669 title: GPG Key description: A unique encryption key type: object @@ -106156,7 +107792,7 @@ paths: - subkeys - revoked examples: - default: &692 + default: &697 value: - id: 3 name: Octocat's GPG Key @@ -106241,9 +107877,9 @@ paths: description: Response content: application/json: - schema: *665 + schema: *669 examples: - default: &666 + default: &670 value: id: 3 name: Octocat's GPG Key @@ -106300,7 +107936,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &667 + - &671 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -106312,9 +107948,9 @@ paths: description: Response content: application/json: - schema: *665 + schema: *669 examples: - default: *666 + default: *670 '404': *6 '304': *35 '403': *27 @@ -106337,7 +107973,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *667 + - *671 responses: '204': description: Response @@ -106616,12 +108252,12 @@ paths: application/json: schema: anyOf: - - *224 + - *228 - type: object properties: {} additionalProperties: false examples: - default: *225 + default: *229 '204': description: Response when there are no restrictions x-github: @@ -106645,7 +108281,7 @@ paths: required: true content: application/json: - schema: *522 + schema: *526 examples: default: value: @@ -106656,7 +108292,7 @@ paths: description: Response content: application/json: - schema: *224 + schema: *228 examples: default: value: @@ -106737,7 +108373,7 @@ paths: - closed - all default: open - - *235 + - *239 - name: sort description: What to sort results by. in: query @@ -106762,7 +108398,7 @@ paths: type: array items: *82 examples: - default: *236 + default: *240 headers: Link: *66 '404': *6 @@ -106795,7 +108431,7 @@ paths: application/json: schema: type: array - items: &668 + items: &672 title: Key description: Key type: object @@ -106898,9 +108534,9 @@ paths: description: Response content: application/json: - schema: *668 + schema: *672 examples: - default: &669 + default: &673 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -106933,15 +108569,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *553 + - *557 responses: '200': description: Response content: application/json: - schema: *668 + schema: *672 examples: - default: *669 + default: *673 '404': *6 '304': *35 '403': *27 @@ -106964,7 +108600,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *553 + - *557 responses: '204': description: Response @@ -106997,7 +108633,7 @@ paths: application/json: schema: type: array - items: &670 + items: &674 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -107076,7 +108712,7 @@ paths: - account - plan examples: - default: &671 + default: &675 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -107138,9 +108774,9 @@ paths: application/json: schema: type: array - items: *670 + items: *674 examples: - default: *671 + default: *675 headers: Link: *66 '304': *35 @@ -107180,7 +108816,7 @@ paths: application/json: schema: type: array - items: *241 + items: *245 examples: default: value: @@ -107294,7 +108930,7 @@ paths: description: Response content: application/json: - schema: *241 + schema: *245 examples: default: value: @@ -107381,7 +109017,7 @@ paths: description: Response content: application/json: - schema: *241 + schema: *245 examples: default: value: @@ -107453,7 +109089,7 @@ paths: application/json: schema: type: array - items: *243 + items: *247 examples: default: value: @@ -107715,7 +109351,7 @@ paths: description: Response content: application/json: - schema: *243 + schema: *247 examples: default: value: @@ -107895,7 +109531,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *244 + - *248 - name: exclude in: query required: false @@ -107908,7 +109544,7 @@ paths: description: Response content: application/json: - schema: *243 + schema: *247 examples: default: value: @@ -108102,7 +109738,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *244 + - *248 responses: '302': description: Response @@ -108128,7 +109764,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *244 + - *248 responses: '204': description: Response @@ -108157,8 +109793,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *244 - - *672 + - *248 + - *676 responses: '204': description: Response @@ -108182,7 +109818,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *244 + - *248 - *17 - *19 responses: @@ -108194,7 +109830,7 @@ paths: type: array items: *153 examples: - default: *255 + default: *259 headers: Link: *66 '404': *6 @@ -108291,7 +109927,7 @@ paths: - docker - nuget - container - - *673 + - *677 - *19 - *17 responses: @@ -108301,10 +109937,10 @@ paths: application/json: schema: type: array - items: *249 + items: *253 examples: - default: *674 - '400': *675 + default: *678 + '400': *679 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -108324,16 +109960,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *251 - - *252 + - *255 + - *256 responses: '200': description: Response content: application/json: - schema: *249 + schema: *253 examples: - default: &693 + default: &698 value: id: 40201 name: octo-name @@ -108446,8 +110082,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *251 - - *252 + - *255 + - *256 responses: '204': description: Response @@ -108477,8 +110113,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *251 - - *252 + - *255 + - *256 - name: token description: package token schema: @@ -108510,8 +110146,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *251 - - *252 + - *255 + - *256 - *19 - *17 - name: state @@ -108531,7 +110167,7 @@ paths: application/json: schema: type: array - items: *253 + items: *257 examples: default: value: @@ -108580,15 +110216,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *251 - - *252 - - *254 + - *255 + - *256 + - *258 responses: '200': description: Response content: application/json: - schema: *253 + schema: *257 examples: default: value: @@ -108624,9 +110260,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *251 - - *252 - - *254 + - *255 + - *256 + - *258 responses: '204': description: Response @@ -108656,9 +110292,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *251 - - *252 - - *254 + - *255 + - *256 + - *258 responses: '204': description: Response @@ -108695,9 +110331,9 @@ paths: application/json: schema: type: array - items: *664 + items: *668 examples: - default: *676 + default: *680 headers: Link: *66 '304': *35 @@ -108810,7 +110446,7 @@ paths: type: array items: *78 examples: - default: &683 + default: &687 summary: Default response value: - id: 1296269 @@ -109128,9 +110764,9 @@ paths: description: Response content: application/json: - schema: *330 + schema: *334 examples: - default: *332 + default: *336 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -109174,9 +110810,9 @@ paths: application/json: schema: type: array - items: *524 + items: *528 examples: - default: *677 + default: *681 headers: Link: *66 '304': *35 @@ -109199,7 +110835,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *228 + - *232 responses: '204': description: Response @@ -109228,7 +110864,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *228 + - *232 responses: '204': description: Response @@ -109261,7 +110897,7 @@ paths: application/json: schema: type: array - items: &678 + items: &682 title: Social account description: Social media account type: object @@ -109278,7 +110914,7 @@ paths: - provider - url examples: - default: &679 + default: &683 value: - provider: twitter url: https://twitter.com/github @@ -109341,9 +110977,9 @@ paths: application/json: schema: type: array - items: *678 + items: *682 examples: - default: *679 + default: *683 '422': *15 '304': *35 '404': *6 @@ -109431,7 +111067,7 @@ paths: application/json: schema: type: array - items: &680 + items: &684 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -109451,7 +111087,7 @@ paths: - title - created_at examples: - default: &711 + default: &716 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -109516,9 +111152,9 @@ paths: description: Response content: application/json: - schema: *680 + schema: *684 examples: - default: &681 + default: &685 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -109548,7 +111184,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &682 + - &686 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -109560,9 +111196,9 @@ paths: description: Response content: application/json: - schema: *680 + schema: *684 examples: - default: *681 + default: *685 '404': *6 '304': *35 '403': *27 @@ -109585,7 +111221,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *682 + - *686 responses: '204': description: Response @@ -109614,7 +111250,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &712 + - &717 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -109639,11 +111275,11 @@ paths: type: array items: *78 examples: - default-response: *683 + default-response: *687 application/vnd.github.v3.star+json: schema: type: array - items: &713 + items: &718 title: Starred Repository description: Starred Repository type: object @@ -109799,8 +111435,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response if this repository is starred by you @@ -109828,8 +111464,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -109853,8 +111489,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *327 - - *328 + - *331 + - *332 responses: '204': description: Response @@ -109889,7 +111525,7 @@ paths: type: array items: *153 examples: - default: *255 + default: *259 headers: Link: *66 '304': *35 @@ -109926,7 +111562,7 @@ paths: application/json: schema: type: array - items: *323 + items: *327 examples: default: value: @@ -110012,10 +111648,10 @@ paths: application/json: schema: oneOf: - - *659 - - *658 + - *663 + - *662 examples: - default-response: &687 + default-response: &691 summary: Default response value: login: octocat @@ -110050,7 +111686,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &688 + response-with-git-hub-plan-information: &692 summary: Response with GitHub plan information value: login: octocat @@ -110107,14 +111743,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &685 + - &689 name: user_id description: The unique identifier of the user. in: path required: true schema: type: string - - *267 + - *271 requestBody: required: true description: Details of the draft item to create in the project. @@ -110148,9 +111784,9 @@ paths: description: Response content: application/json: - schema: *272 + schema: *276 examples: - draft_issue: *273 + draft_issue: *277 '304': *35 '403': *27 '401': *23 @@ -110173,7 +111809,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *684 + - *688 - *17 responses: '200': @@ -110208,8 +111844,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *685 - - *267 + - *689 + - *271 requestBody: required: true content: @@ -110283,17 +111919,17 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *686 + schema: *690 examples: table_view: summary: Response for creating a table view - value: *277 + value: *281 board_view: summary: Response for creating a board view with filter - value: *277 + value: *281 roadmap_view: summary: Response for creating a roadmap view - value: *277 + value: *281 '304': *35 '403': *27 '401': *23 @@ -110335,11 +111971,11 @@ paths: application/json: schema: oneOf: - - *659 - - *658 + - *663 + - *662 examples: - default-response: *687 - response-with-git-hub-plan-information: *688 + default-response: *691 + response-with-git-hub-plan-information: *692 '404': *6 x-github: githubCloudOnly: false @@ -110389,8 +112025,8 @@ paths: required: - subject_digests examples: - default: *689 - withPredicateType: *690 + default: *693 + withPredicateType: *694 responses: '200': description: Response @@ -110444,7 +112080,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *691 + default: *695 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110664,7 +112300,7 @@ paths: initiator: type: string examples: - default: *388 + default: *392 '201': description: Response content: @@ -110695,6 +112331,1244 @@ paths: properties: bundle: version: '2026-03-10' + "/users/{username}/copilot-spaces": + get: + summary: List Copilot Spaces for a user + description: |- + Lists Copilot Spaces owned by a user. The authenticated user must have read access to the user's Copilot Spaces. + + Only Spaces that are readable by the authenticated user are returned. This includes the user's own spaces, and public user spaces when accessing another user's spaces. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-copilot-spaces-for-a-user + parameters: + - *70 + - name: per_page + description: The number of results per page (max 100). + in: query + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: before + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + in: query + schema: + type: string + - name: after + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. + in: query + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - spaces + properties: + spaces: + type: array + description: The list of Copilot Spaces on this page of results. + items: *187 + examples: + default: + summary: Example response for listing user copilot spaces + value: + spaces: + - id: 42 + number: 1 + name: Personal Research Space + description: My personal space for research and development + owner: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-16T10:15:00Z' + updated_at: '2023-02-16T16:30:00Z' + html_url: https://github.com/copilot/spaces/octocat/1 + api_url: https://api.github.com/user/1/copilot-spaces/1 + - id: 43 + number: 2 + name: Learning Space + description: Space for learning new technologies + owner: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-17T08:20:00Z' + updated_at: '2023-02-17T14:45:00Z' + html_url: https://github.com/copilot/spaces/octocat/2 + api_url: https://api.github.com/user/1/copilot-spaces/2 + headers: + Link: *66 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + post: + summary: Create a Copilot Space for a user + description: |- + Creates a new Copilot Space owned by a user. Only the authenticated user can create spaces for their own account. + + Users can create personal Copilot Spaces for their individual use. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-a-copilot-space-for-a-user + parameters: + - *70 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - My Development Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Personal space for development assistance + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Help me with React development patterns and best practices + base_role: + type: string + enum: + - reader + - no_access + description: |- + The base role that determines default permissions for the space. + - `no_access`: No default access (default) + - `reader`: Makes the space publicly readable + Note: User spaces do not support writer or admin base roles. + default: no_access + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + required: + - name + examples: + default: + value: + name: My Development Space + description: Personal space for development assistance + general_instructions: Help me with React development patterns and + best practices + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 789012 + file_path: src/components/App.js + - resource_type: free_text + metadata: + name: Development Notes + text: Focus on clean code principles and modern React patterns + responses: + '201': + description: Response + content: + application/json: + schema: *187 + examples: + default: &696 + summary: Example response for a user copilot space + value: + id: 42 + number: 5 + name: My Development Space + description: Personal space for React development patterns + general_instructions: Focus on React functional components, hooks, + and modern development patterns + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-15T08:30:00Z' + updated_at: '2023-02-15T14:45:00Z' + html_url: https://github.com/copilot/spaces/octocat/5 + api_url: https://api.github.com/user/1/copilot-spaces/5 + base_role: no_access + resources_attributes: + - id: 789 + resource_type: github_file + metadata: + repository_id: 1234 + file_path: src/components/App.tsx + - id: 790 + resource_type: free_text + metadata: + name: React Best Practices + text: Use functional components with hooks + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + "/users/{username}/copilot-spaces/{space_number}": + get: + summary: Get a Copilot Space for a user + description: |- + Gets details about a specific Copilot Space owned by a user. The authenticated user must have read access to the Space. + + Private user spaces require the authenticated user to be the owner of the space. + Public user spaces are accessible to any authenticated user. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *187 + examples: + default: *696 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + put: + summary: Set a Copilot Space for a user + description: |- + Updates a Copilot Space owned by a user. Only the authenticated user can update spaces for their own account. + + Users can update their personal Copilot Spaces. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - Updated Development Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Updated personal space for development assistance + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Updated instructions to help me with React development patterns + and best practices + base_role: + type: string + enum: + - reader + - no_access + description: |- + The base role that determines default permissions for the space. Changing this field requires admin permissions. + - `no_access`: No default access (default) + - `reader`: Makes the space publicly readable + Note: User spaces do not support writer or admin base roles. + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + examples: + default: + value: + name: Updated Development Space + description: Updated personal space for development assistance + general_instructions: Updated instructions to help me with React + development patterns and best practices + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 789012 + file_path: src/components/UpdatedApp.js + - id: 123 + _destroy: true + - id: 456 + resource_type: free_text + metadata: + name: Updated Development Notes + text: Updated focus on clean code principles and modern React + patterns + responses: + '200': + description: Response + content: + application/json: + schema: *187 + examples: + default: *696 + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + delete: + summary: Delete a Copilot Space for a user + description: |- + Deletes a Copilot Space owned by a user. The authenticated user must be the owner of the space. + + **Warning:** This action is permanent and cannot be undone. Deleting a space will remove all associated resources and configurations. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '204': + description: The Copilot Space has been successfully deleted. + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + "/users/{username}/copilot-spaces/{space_number}/collaborators": + get: + summary: List collaborators for a Copilot Space for a user + description: |- + Lists all collaborators for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + Each collaborator entry specifies which user has access to the space and at what level (reader, writer, or admin). The space owner is excluded from this list. + + Team collaborators are not supported for user-owned Copilot Spaces. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-collaborators-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - collaborators + properties: + collaborators: + type: array + description: The list of collaborators for this Copilot Space. + items: *189 + examples: + default: + value: + collaborators: + - actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + - actor_type: User + role: reader + login: github-user + id: 67890 + node_id: MDQ6VXNlcjY3ODkw + avatar_url: https://github.com/images/error/other_user.gif + gravatar_id: '' + url: https://api.github.com/users/github-user + html_url: https://github.com/github-user + followers_url: https://api.github.com/users/github-user/followers + following_url: https://api.github.com/users/github-user/following{/other_user} + gists_url: https://api.github.com/users/github-user/gists{/gist_id} + starred_url: https://api.github.com/users/github-user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github-user/subscriptions + organizations_url: https://api.github.com/users/github-user/orgs + repos_url: https://api.github.com/users/github-user/repos + events_url: https://api.github.com/users/github-user/events{/privacy} + received_events_url: https://api.github.com/users/github-user/received_events + type: User + user_view_type: public + site_admin: false + name: GitHub User + company: + blog: '' + location: + email: + hireable: + bio: + twitter_username: + public_repos: 5 + public_gists: 0 + followers: 10 + following: 5 + created_at: '2010-01-14T04:33:35Z' + updated_at: '2010-01-14T04:33:35Z' + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + post: + summary: Add a collaborator to a Copilot Space for a user + description: |- + Adds a collaborator to a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + Team collaborators are not supported for user-owned Copilot Spaces. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/add-collaborator-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - actor_type + - actor_identifier + - role + properties: + actor_type: + type: string + enum: + - User + - Team + description: The type of actor (must be `User` for user-owned spaces; + `Team` will be rejected). + actor_identifier: + type: string + description: The username of the collaborator. The numeric user + ID is also accepted. + role: + type: string + enum: + - reader + - writer + - admin + description: The role to grant to the collaborator. + examples: + default: + value: + actor_type: User + actor_identifier: octocat + role: writer + responses: + '201': + description: Response + content: + application/json: + schema: *189 + examples: + default: + value: + actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": + put: + summary: Set a collaborator role for a Copilot Space for a user + description: |- + Updates the role of a collaborator for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-collaborator-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (must be `User` for user-owned spaces; `Team` + will be rejected). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username of the collaborator. The numeric user ID is also + accepted. + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - role + properties: + role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: The new role to grant to the collaborator. Use `no_access` + to remove the collaborator. + examples: + default: + value: + role: admin + responses: + '200': + description: Response + content: + application/json: + schema: *189 + examples: + default: + value: + actor_type: User + role: admin + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + '204': + description: Response when `role` is `no_access` and the collaborator was + removed. + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + delete: + summary: Remove a collaborator from a Copilot Space for a user + description: |- + Removes a collaborator from a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/remove-collaborator-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (must be `User` for user-owned spaces; `Team` + will be rejected). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username of the collaborator. The numeric user ID is also + accepted. + in: path + required: true + schema: + type: string + responses: + '204': + description: Response + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + "/users/{username}/copilot-spaces/{space_number}/resources": + get: + summary: List resources for a Copilot Space for a user + description: |- + Lists all resources attached to a specific Copilot Space owned by a user. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-resources-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - resources + properties: + resources: + type: array + description: The list of resources attached to this Copilot Space. + items: *190 + examples: + default: + value: + resources: + - id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + post: + summary: Create a resource for a Copilot Space for a user + description: |- + Creates a new resource in a specific Copilot Space owned by a user. + The authenticated user must have write permissions on the space. + + The following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`. + The `uploaded_text_file` and `media_content` types are not supported via this endpoint. + + For `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status. + + OAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - resource_type + - metadata + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + description: The type of resource to create. + metadata: + type: object + description: Resource-specific metadata. + additionalProperties: true + examples: + free_text: + value: + resource_type: free_text + metadata: + name: notes.txt + text: Some helpful notes + repository: + value: + resource_type: repository + metadata: + repository_id: 42 + github_file: + value: + resource_type: github_file + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + responses: + '201': + description: Resource created + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '200': + description: Duplicate github_file resource already exists + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: github_file + copilot_chat_attachment_id: + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}": + get: + summary: Get a resource for a Copilot Space for a user + description: |- + Gets a specific resource attached to a Copilot Space owned by a user. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + put: + summary: Set a resource for a Copilot Space for a user + description: |- + Updates the metadata of a resource in a specific Copilot Space owned by a user. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + description: Updated resource-specific metadata. + additionalProperties: true + examples: + default: + value: + metadata: + name: updated-notes.txt + text: Updated content + responses: + '200': + description: Response + content: + application/json: + schema: *190 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: updated-notes.txt + text: Updated content + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T12:00:00Z' + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + delete: + summary: Delete a resource from a Copilot Space for a user + description: |- + Deletes a resource from a specific Copilot Space owned by a user. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-a-copilot-space-for-a-user + parameters: + - *70 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources "/users/{username}/docker/conflicts": get: summary: Get list of conflicting packages during Docker migration for user @@ -110717,9 +113591,9 @@ paths: application/json: schema: type: array - items: *249 + items: *253 examples: - default: *674 + default: *678 '403': *27 '401': *23 x-github: @@ -111103,9 +113977,9 @@ paths: application/json: schema: type: array - items: *665 + items: *669 examples: - default: *692 + default: *697 headers: Link: *66 x-github: @@ -111209,7 +114083,7 @@ paths: application/json: schema: *20 examples: - default: *521 + default: *525 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -111334,7 +114208,7 @@ paths: - docker - nuget - container - - *673 + - *677 - *70 - *19 - *17 @@ -111345,12 +114219,12 @@ paths: application/json: schema: type: array - items: *249 + items: *253 examples: - default: *674 + default: *678 '403': *27 '401': *23 - '400': *675 + '400': *679 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -111370,17 +114244,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *251 - - *252 + - *255 + - *256 - *70 responses: '200': description: Response content: application/json: - schema: *249 + schema: *253 examples: - default: *693 + default: *698 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -111401,8 +114275,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *251 - - *252 + - *255 + - *256 - *70 responses: '204': @@ -111435,8 +114309,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *251 - - *252 + - *255 + - *256 - *70 - name: token description: package token @@ -111469,8 +114343,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *251 - - *252 + - *255 + - *256 - *70 responses: '200': @@ -111479,7 +114353,7 @@ paths: application/json: schema: type: array - items: *253 + items: *257 examples: default: value: @@ -111537,16 +114411,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *251 - - *252 - - *254 + - *255 + - *256 + - *258 - *70 responses: '200': description: Response content: application/json: - schema: *253 + schema: *257 examples: default: value: @@ -111581,10 +114455,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *251 - - *252 + - *255 + - *256 - *70 - - *254 + - *258 responses: '204': description: Response @@ -111616,10 +114490,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *251 - - *252 + - *255 + - *256 - *70 - - *254 + - *258 responses: '204': description: Response @@ -111660,9 +114534,9 @@ paths: application/json: schema: type: array - items: *265 + items: *269 examples: - default: *266 + default: *270 headers: Link: *66 '304': *35 @@ -111684,16 +114558,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-user parameters: - - *267 + - *271 - *70 responses: '200': description: Response content: application/json: - schema: *265 + schema: *269 examples: - default: *266 + default: *270 headers: Link: *66 '304': *35 @@ -111715,7 +114589,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user parameters: - - *267 + - *271 - *70 - *17 - *45 @@ -111727,9 +114601,9 @@ paths: application/json: schema: type: array - items: *270 + items: *274 examples: - default: *694 + default: *699 headers: Link: *66 '304': *35 @@ -111751,7 +114625,7 @@ paths: url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project parameters: - *70 - - *267 + - *271 requestBody: required: true content: @@ -111789,7 +114663,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *695 + items: *700 required: - name - data_type @@ -111805,7 +114679,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *696 + iteration_configuration: *701 required: - name - data_type @@ -111827,20 +114701,20 @@ paths: value: name: Due date data_type: date - single_select_field: *697 - iteration_field: *698 + single_select_field: *702 + iteration_field: *703 responses: '201': description: Response content: application/json: - schema: *270 + schema: *274 examples: - text_field: *699 - number_field: *700 - date_field: *701 - single_select_field: *702 - iteration_field: *703 + text_field: *704 + number_field: *705 + date_field: *706 + single_select_field: *707 + iteration_field: *708 '304': *35 '403': *27 '401': *23 @@ -111861,17 +114735,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - - *267 - - *704 + - *271 + - *709 - *70 responses: '200': description: Response content: application/json: - schema: *270 + schema: *274 examples: - default: *705 + default: *710 headers: Link: *66 '304': *35 @@ -111894,7 +114768,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project parameters: - - *267 + - *271 - *70 - *45 - *46 @@ -111927,9 +114801,9 @@ paths: application/json: schema: type: array - items: *274 + items: *278 examples: - default: *275 + default: *279 headers: Link: *66 '304': *35 @@ -111951,7 +114825,7 @@ paths: url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project parameters: - *70 - - *267 + - *271 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -112021,22 +114895,22 @@ paths: description: Response content: application/json: - schema: *272 + schema: *276 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *273 + value: *277 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *273 + value: *277 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *273 + value: *277 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *273 + value: *277 '304': *35 '403': *27 '401': *23 @@ -112056,9 +114930,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *267 + - *271 - *70 - - *276 + - *280 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -112078,9 +114952,9 @@ paths: description: Response content: application/json: - schema: *274 + schema: *278 examples: - default: *275 + default: *279 headers: Link: *66 '304': *35 @@ -112101,9 +114975,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-user parameters: - - *267 + - *271 - *70 - - *276 + - *280 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -112176,13 +115050,13 @@ paths: description: Response content: application/json: - schema: *274 + schema: *278 examples: - text_field: *275 - number_field: *275 - date_field: *275 - single_select_field: *275 - iteration_field: *275 + text_field: *279 + number_field: *279 + date_field: *279 + single_select_field: *279 + iteration_field: *279 '401': *23 '403': *27 '404': *6 @@ -112202,9 +115076,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-user parameters: - - *267 + - *271 - *70 - - *276 + - *280 responses: '204': description: Response @@ -112226,9 +115100,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-project-view parameters: - - *267 + - *271 - *70 - - *706 + - *711 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -112254,9 +115128,9 @@ paths: application/json: schema: type: array - items: *274 + items: *278 examples: - default: *275 + default: *279 headers: Link: *66 '304': *35 @@ -112477,7 +115351,7 @@ paths: type: array items: *153 examples: - default: *255 + default: *259 headers: Link: *66 x-github: @@ -112503,7 +115377,7 @@ paths: - *116 - *118 - *117 - - *707 + - *712 - *119 responses: '200': @@ -112634,7 +115508,7 @@ paths: parameters: - *70 - *116 - - *708 + - *713 - *117 responses: '200': @@ -112733,9 +115607,9 @@ paths: - *116 - *118 - *117 - - *709 + - *714 - *119 - - *710 + - *715 responses: '200': description: Response when getting a billing usage summary @@ -112869,9 +115743,9 @@ paths: application/json: schema: type: array - items: *678 + items: *682 examples: - default: *679 + default: *683 headers: Link: *66 x-github: @@ -112901,9 +115775,9 @@ paths: application/json: schema: type: array - items: *680 + items: *684 examples: - default: *711 + default: *716 headers: Link: *66 x-github: @@ -112928,7 +115802,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *70 - - *712 + - *717 - *60 - *17 - *19 @@ -112940,11 +115814,11 @@ paths: schema: anyOf: - type: array - items: *713 + items: *718 - type: array items: *78 examples: - default-response: *683 + default-response: *687 headers: Link: *66 x-github: @@ -112975,7 +115849,7 @@ paths: type: array items: *153 examples: - default: *255 + default: *259 headers: Link: *66 x-github: @@ -113104,7 +115978,7 @@ webhooks: type: string enum: - disabled - enterprise: &714 + enterprise: &719 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -113173,7 +116047,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &715 + installation: &720 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -113194,7 +116068,7 @@ webhooks: required: - id - node_id - organization: &716 + organization: &721 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -113267,7 +116141,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &717 + repository: &722 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -114207,10 +117081,10 @@ webhooks: type: string enum: - enabled - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -114286,11 +117160,11 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - rule: &718 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + rule: &723 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -114513,11 +117387,11 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - rule: *718 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + rule: *723 sender: *4 required: - action @@ -114705,11 +117579,11 @@ webhooks: - everyone required: - from - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - rule: *718 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + rule: *723 sender: *4 required: - action @@ -114793,7 +117667,7 @@ webhooks: type: string enum: - completed - check_run: &720 + check_run: &725 title: CheckRun description: A check performed on the code of a given code change type: object @@ -114903,7 +117777,7 @@ webhooks: - examples: - neutral - deployment: *719 + deployment: *724 details_url: type: string examples: @@ -115001,10 +117875,10 @@ webhooks: - output - app - pull_requests - installation: *715 - enterprise: *714 - organization: *716 - repository: *717 + installation: *720 + enterprise: *719 + organization: *721 + repository: *722 sender: *4 required: - check_run @@ -115395,11 +118269,11 @@ webhooks: type: string enum: - created - check_run: *720 - installation: *715 - enterprise: *714 - organization: *716 - repository: *717 + check_run: *725 + installation: *720 + enterprise: *719 + organization: *721 + repository: *722 sender: *4 required: - check_run @@ -115793,11 +118667,11 @@ webhooks: type: string enum: - requested_action - check_run: *720 - installation: *715 - enterprise: *714 - organization: *716 - repository: *717 + check_run: *725 + installation: *720 + enterprise: *719 + organization: *721 + repository: *722 requested_action: description: The action requested by the user. type: object @@ -116200,11 +119074,11 @@ webhooks: type: string enum: - rerequested - check_run: *720 - installation: *715 - enterprise: *714 - organization: *716 - repository: *717 + check_run: *725 + installation: *720 + enterprise: *719 + organization: *721 + repository: *722 sender: *4 required: - check_run @@ -117189,10 +120063,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -117896,10 +120770,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -118597,10 +121471,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -118769,7 +121643,7 @@ webhooks: required: - login - id - dismissed_comment: *419 + dismissed_comment: *423 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -118921,20 +121795,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &721 + commit_oid: &726 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *714 - installation: *715 - organization: *716 - ref: &722 + enterprise: *719 + installation: *720 + organization: *721 + ref: &727 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *717 + repository: *722 sender: *4 required: - action @@ -119101,7 +121975,7 @@ webhooks: required: - login - id - dismissed_comment: *419 + dismissed_comment: *423 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -119342,12 +122216,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *721 - enterprise: *714 - installation: *715 - organization: *716 - ref: *722 - repository: *717 + commit_oid: *726 + enterprise: *719 + installation: *720 + organization: *721 + ref: *727 + repository: *722 sender: *4 required: - action @@ -119445,7 +122319,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *419 + dismissed_comment: *423 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -119630,12 +122504,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *721 - enterprise: *714 - installation: *715 - organization: *716 - ref: *722 - repository: *717 + commit_oid: *726 + enterprise: *719 + installation: *720 + organization: *721 + ref: *727 + repository: *722 sender: *4 required: - action @@ -119804,7 +122678,7 @@ webhooks: required: - login - id - dismissed_comment: *419 + dismissed_comment: *423 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -119981,12 +122855,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *721 - enterprise: *714 - installation: *715 - organization: *716 - ref: *722 - repository: *717 + commit_oid: *726 + enterprise: *719 + installation: *720 + organization: *721 + ref: *727 + repository: *722 sender: *4 required: - action @@ -120087,7 +122961,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *419 + dismissed_comment: *423 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -120276,9 +123150,9 @@ webhooks: type: - string - 'null' - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -120286,7 +123160,7 @@ webhooks: type: - string - 'null' - repository: *717 + repository: *722 sender: *4 required: - action @@ -120385,7 +123259,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *419 + dismissed_comment: *423 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -120532,12 +123406,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *721 - enterprise: *714 - installation: *715 - organization: *716 - ref: *722 - repository: *717 + commit_oid: *726 + enterprise: *719 + installation: *720 + organization: *721 + ref: *727 + repository: *722 sender: *4 required: - action @@ -120706,7 +123580,7 @@ webhooks: required: - login - id - dismissed_comment: *419 + dismissed_comment: *423 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -120858,10 +123732,10 @@ webhooks: - dismissed_reason - rule - tool - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -121121,10 +123995,10 @@ webhooks: - updated_at - author_association - body - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -121205,18 +124079,18 @@ webhooks: type: - string - 'null' - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *716 - pusher_type: &723 + organization: *721 + pusher_type: &728 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &724 + ref: &729 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -121226,7 +124100,7 @@ webhooks: enum: - tag - branch - repository: *717 + repository: *722 sender: *4 required: - ref @@ -121308,10 +124182,10 @@ webhooks: type: string enum: - created - definition: *278 - enterprise: *714 - installation: *715 - organization: *716 + definition: *282 + enterprise: *719 + installation: *720 + organization: *721 sender: *4 required: - action @@ -121396,9 +124270,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 sender: *4 required: - action @@ -121475,10 +124349,10 @@ webhooks: type: string enum: - promote_to_enterprise - definition: *278 - enterprise: *714 - installation: *715 - organization: *716 + definition: *282 + enterprise: *719 + installation: *720 + organization: *721 sender: *4 required: - action @@ -121555,10 +124429,10 @@ webhooks: type: string enum: - updated - definition: *278 - enterprise: *714 - installation: *715 - organization: *716 + definition: *282 + enterprise: *719 + installation: *720 + organization: *721 sender: *4 required: - action @@ -121635,19 +124509,19 @@ webhooks: type: string enum: - updated - enterprise: *714 - installation: *715 - repository: *717 - organization: *716 + enterprise: *719 + installation: *720 + repository: *722 + organization: *721 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *282 + items: *286 old_property_values: type: array description: The old custom property values for the repository. - items: *282 + items: *286 required: - action - repository @@ -121723,18 +124597,18 @@ webhooks: title: delete event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 - pusher_type: *723 - ref: *724 + enterprise: *719 + installation: *720 + organization: *721 + pusher_type: *728 + ref: *729 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *717 + repository: *722 sender: *4 required: - ref @@ -121814,11 +124688,11 @@ webhooks: type: string enum: - assignees_changed - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -121898,11 +124772,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -121983,11 +124857,11 @@ webhooks: type: string enum: - auto_reopened - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -122068,11 +124942,11 @@ webhooks: type: string enum: - created - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -122151,11 +125025,11 @@ webhooks: type: string enum: - dismissed - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -122234,11 +125108,11 @@ webhooks: type: string enum: - fixed - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -122318,11 +125192,11 @@ webhooks: type: string enum: - reintroduced - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -122401,11 +125275,11 @@ webhooks: type: string enum: - reopened - alert: *479 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *483 + installation: *720 + organization: *721 + enterprise: *719 + repository: *722 sender: *4 required: - action @@ -122482,9 +125356,9 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - key: &725 + enterprise: *719 + installation: *720 + key: &730 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -122522,8 +125396,8 @@ webhooks: - verified - created_at - read_only - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -122600,11 +125474,11 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - key: *725 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + key: *730 + organization: *721 + repository: *722 sender: *4 required: - action @@ -123171,12 +126045,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - workflow: &729 + workflow: &734 title: Workflow type: - object @@ -123927,13 +126801,13 @@ webhooks: deployment: anyOf: - type: 'null' - - *486 + - *490 pull_requests: type: array - items: *571 - repository: *717 - organization: *716 - installation: *715 + items: *575 + repository: *722 + organization: *721 + installation: *720 sender: *4 responses: '200': @@ -124004,7 +126878,7 @@ webhooks: type: string enum: - approved - approver: &726 + approver: &731 type: object properties: avatar_url: @@ -124047,11 +126921,11 @@ webhooks: type: string comment: type: string - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - reviewers: &727 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + reviewers: &732 type: array items: type: object @@ -124132,7 +127006,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &728 + workflow_job_run: &733 type: object properties: conclusion: @@ -124878,18 +127752,18 @@ webhooks: type: string enum: - rejected - approver: *726 + approver: *731 comment: type: string - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - reviewers: *727 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + reviewers: *732 sender: *4 since: type: string - workflow_job_run: *728 + workflow_job_run: *733 workflow_job_runs: type: array items: @@ -125606,13 +128480,13 @@ webhooks: type: string enum: - requested - enterprise: *714 + enterprise: *719 environment: type: string - installation: *715 - organization: *716 - repository: *717 - requestor: &734 + installation: *720 + organization: *721 + repository: *722 + requestor: &739 title: User type: - object @@ -127545,12 +130419,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - workflow: *729 + workflow: *734 workflow_run: title: Deployment Workflow Run type: @@ -128241,7 +131115,7 @@ webhooks: type: string enum: - answered - answer: &732 + answer: &737 type: object properties: author_association: @@ -128401,11 +131275,11 @@ webhooks: - created_at - updated_at - body - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128532,11 +131406,11 @@ webhooks: - from required: - category - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128619,11 +131493,11 @@ webhooks: type: string enum: - closed - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128705,7 +131579,7 @@ webhooks: type: string enum: - created - comment: &731 + comment: &736 type: object properties: author_association: @@ -128865,11 +131739,11 @@ webhooks: - updated_at - body - reactions - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -128952,12 +131826,12 @@ webhooks: type: string enum: - deleted - comment: *731 - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + comment: *736 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -129052,12 +131926,12 @@ webhooks: - from required: - body - comment: *731 - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + comment: *736 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -129141,11 +132015,11 @@ webhooks: type: string enum: - created - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -129227,11 +132101,11 @@ webhooks: type: string enum: - deleted - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -129331,11 +132205,11 @@ webhooks: type: string required: - from - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -129417,10 +132291,10 @@ webhooks: type: string enum: - labeled - discussion: *730 - enterprise: *714 - installation: *715 - label: &733 + discussion: *735 + enterprise: *719 + installation: *720 + label: &738 title: Label type: object properties: @@ -129453,8 +132327,8 @@ webhooks: - color - default - description - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -129537,11 +132411,11 @@ webhooks: type: string enum: - locked - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -129623,11 +132497,11 @@ webhooks: type: string enum: - pinned - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -129709,11 +132583,11 @@ webhooks: type: string enum: - reopened - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -129798,16 +132672,16 @@ webhooks: changes: type: object properties: - new_discussion: *730 - new_repository: *717 + new_discussion: *735 + new_repository: *722 required: - new_discussion - new_repository - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -129890,10 +132764,10 @@ webhooks: type: string enum: - unanswered - discussion: *730 - old_answer: *732 - organization: *716 - repository: *717 + discussion: *735 + old_answer: *737 + organization: *721 + repository: *722 sender: *4 required: - action @@ -129975,12 +132849,12 @@ webhooks: type: string enum: - unlabeled - discussion: *730 - enterprise: *714 - installation: *715 - label: *733 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + label: *738 + organization: *721 + repository: *722 sender: *4 required: - action @@ -130063,11 +132937,11 @@ webhooks: type: string enum: - unlocked - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -130149,11 +133023,11 @@ webhooks: type: string enum: - unpinned - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *735 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -130226,7 +133100,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *714 + enterprise: *719 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -130904,9 +133778,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - forkee @@ -131052,9 +133926,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pages: description: The pages that were updated. type: array @@ -131092,7 +133966,7 @@ webhooks: - action - sha - html_url - repository: *717 + repository: *722 sender: *4 required: - pages @@ -131168,10 +134042,10 @@ webhooks: type: string enum: - created - enterprise: *714 + enterprise: *719 installation: *20 - organization: *716 - repositories: &735 + organization: *721 + repositories: &740 description: An array of repository objects that the installation can access. type: array @@ -131197,8 +134071,8 @@ webhooks: - name - full_name - private - repository: *717 - requester: *734 + repository: *722 + requester: *739 sender: *4 required: - action @@ -131273,11 +134147,11 @@ webhooks: type: string enum: - deleted - enterprise: *714 + enterprise: *719 installation: *20 - organization: *716 - repositories: *735 - repository: *717 + organization: *721 + repositories: *740 + repository: *722 requester: type: - 'null' @@ -131354,11 +134228,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *714 + enterprise: *719 installation: *20 - organization: *716 - repositories: *735 - repository: *717 + organization: *721 + repositories: *740 + repository: *722 requester: type: - 'null' @@ -131435,10 +134309,10 @@ webhooks: type: string enum: - added - enterprise: *714 + enterprise: *719 installation: *20 - organization: *716 - repositories_added: &736 + organization: *721 + repositories_added: &741 description: An array of repository objects, which were added to the installation. type: array @@ -131484,15 +134358,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *717 - repository_selection: &737 + repository: *722 + repository_selection: &742 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *734 + requester: *739 sender: *4 required: - action @@ -131571,10 +134445,10 @@ webhooks: type: string enum: - removed - enterprise: *714 + enterprise: *719 installation: *20 - organization: *716 - repositories_added: *736 + organization: *721 + repositories_added: *741 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -131601,9 +134475,9 @@ webhooks: - name - full_name - private - repository: *717 - repository_selection: *737 - requester: *734 + repository: *722 + repository_selection: *742 + requester: *739 sender: *4 required: - action @@ -131682,11 +134556,11 @@ webhooks: type: string enum: - suspend - enterprise: *714 + enterprise: *719 installation: *20 - organization: *716 - repositories: *735 - repository: *717 + organization: *721 + repositories: *740 + repository: *722 requester: type: - 'null' @@ -131868,10 +134742,10 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 target_type: type: string @@ -131950,11 +134824,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *714 + enterprise: *719 installation: *20 - organization: *716 - repositories: *735 - repository: *717 + organization: *721 + repositories: *740 + repository: *722 requester: type: - 'null' @@ -132120,7 +134994,7 @@ webhooks: pin: anyOf: - type: 'null' - - *550 + - *554 user: title: User type: @@ -132206,8 +135080,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -133019,8 +135893,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133037,7 +135911,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -133381,8 +136255,8 @@ webhooks: - state - locked - assignee - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -133462,7 +136336,7 @@ webhooks: type: string enum: - deleted - comment: &738 + comment: &743 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -133619,7 +136493,7 @@ webhooks: pin: anyOf: - type: 'null' - - *550 + - *554 required: - url - html_url @@ -133633,8 +136507,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -134442,8 +137316,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134460,7 +137334,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -134806,8 +137680,8 @@ webhooks: - state - locked - assignee - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -134887,7 +137761,7 @@ webhooks: type: string enum: - edited - changes: &762 + changes: &767 description: The changes to the comment. type: object properties: @@ -134899,9 +137773,9 @@ webhooks: type: string required: - from - comment: *738 - enterprise: *714 - installation: *715 + comment: *743 + enterprise: *719 + installation: *720 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -135712,8 +138586,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135730,7 +138604,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -136074,8 +138948,8 @@ webhooks: - state - locked - assignee - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -136156,9 +139030,9 @@ webhooks: type: string enum: - pinned - comment: *738 - enterprise: *714 - installation: *715 + comment: *743 + enterprise: *719 + installation: *720 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -136971,8 +139845,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136989,7 +139863,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -137335,8 +140209,8 @@ webhooks: - state - locked - assignee - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -137416,9 +140290,9 @@ webhooks: type: string enum: - unpinned - comment: *738 - enterprise: *714 - installation: *715 + comment: *743 + enterprise: *719 + installation: *720 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -138231,8 +141105,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138249,7 +141123,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -138595,8 +141469,8 @@ webhooks: - state - locked - assignee - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -138685,9 +141559,9 @@ webhooks: type: number blocking_issue: *82 blocking_issue_repo: *78 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -138776,9 +141650,9 @@ webhooks: type: number blocking_issue: *82 blocking_issue_repo: *78 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -138866,9 +141740,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -138957,9 +141831,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -139039,10 +141913,10 @@ webhooks: type: string enum: - assigned - assignee: *734 - enterprise: *714 - installation: *715 - issue: &739 + assignee: *739 + enterprise: *719 + installation: *720 + issue: &744 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -139853,11 +142727,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139874,7 +142748,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -139977,8 +142851,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -140058,8 +142932,8 @@ webhooks: type: string enum: - closed - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -140875,11 +143749,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140896,7 +143770,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -141142,8 +144016,8 @@ webhooks: required: - state - closed_at - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -141222,8 +144096,8 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -142030,11 +144904,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142051,7 +144925,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -142153,8 +145027,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -142233,8 +145107,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -143064,11 +145938,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143085,7 +145959,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -143166,7 +146040,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &740 + milestone: &745 title: Milestone description: A collection of related issues and pull requests. type: object @@ -143309,8 +146183,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -143409,8 +146283,8 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144221,11 +147095,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144239,7 +147113,7 @@ webhooks: timeline_url: type: string format: uri - type: *232 + type: *236 title: description: Title of the issue type: string @@ -144345,9 +147219,9 @@ webhooks: - active_lock_reason - body - reactions - label: *733 - organization: *716 - repository: *717 + label: *738 + organization: *721 + repository: *722 sender: *4 required: - action @@ -144427,9 +147301,9 @@ webhooks: type: string enum: - field_added - enterprise: *714 - installation: *715 - issue: *739 + enterprise: *719 + installation: *720 + issue: *744 issue_field: type: object description: The issue field whose value was set or updated on the @@ -144548,8 +147422,8 @@ webhooks: - id required: - from - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -144629,9 +147503,9 @@ webhooks: type: string enum: - field_removed - enterprise: *714 - installation: *715 - issue: *739 + enterprise: *719 + installation: *720 + issue: *744 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -144694,8 +147568,8 @@ webhooks: - 'null' required: - id - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -144775,8 +147649,8 @@ webhooks: type: string enum: - labeled - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -145586,11 +148460,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145604,7 +148478,7 @@ webhooks: timeline_url: type: string format: uri - type: *232 + type: *236 title: description: Title of the issue type: string @@ -145710,9 +148584,9 @@ webhooks: - active_lock_reason - body - reactions - label: *733 - organization: *716 - repository: *717 + label: *738 + organization: *721 + repository: *722 sender: *4 required: - action @@ -145792,8 +148666,8 @@ webhooks: type: string enum: - locked - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -146628,11 +149502,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146646,7 +149520,7 @@ webhooks: timeline_url: type: string format: uri - type: *232 + type: *236 title: description: Title of the issue type: string @@ -146729,8 +149603,8 @@ webhooks: format: uri user_view_type: type: string - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -146809,8 +149683,8 @@ webhooks: type: string enum: - milestoned - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -147639,11 +150513,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147660,7 +150534,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -147740,9 +150614,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *740 - organization: *716 - repository: *717 + milestone: *745 + organization: *721 + repository: *722 sender: *4 required: - action @@ -148629,11 +151503,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148733,7 +151607,7 @@ webhooks: required: - login - id - type: *232 + type: *236 required: - id - number @@ -149225,8 +152099,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -150033,11 +152907,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150054,7 +152928,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -150160,8 +153034,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -150241,9 +153115,9 @@ webhooks: type: string enum: - pinned - enterprise: *714 - installation: *715 - issue: &741 + enterprise: *719 + installation: *720 + issue: &746 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -151048,11 +153922,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151069,7 +153943,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -151171,8 +154045,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -151251,8 +154125,8 @@ webhooks: type: string enum: - reopened - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -152085,11 +154959,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152186,9 +155060,9 @@ webhooks: format: uri user_view_type: type: string - type: *232 - organization: *716 - repository: *717 + type: *236 + organization: *721 + repository: *722 sender: *4 required: - action @@ -153076,11 +155950,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153097,7 +155971,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -153690,11 +156564,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *714 - installation: *715 - issue: *741 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + issue: *746 + organization: *721 + repository: *722 sender: *4 required: - action @@ -153774,12 +156648,12 @@ webhooks: type: string enum: - typed - enterprise: *714 - installation: *715 - issue: *739 - type: *232 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + issue: *744 + type: *236 + organization: *721 + repository: *722 sender: *4 required: - action @@ -153860,7 +156734,7 @@ webhooks: type: string enum: - unassigned - assignee: &765 + assignee: &770 title: User type: - object @@ -153932,11 +156806,11 @@ webhooks: required: - login - id - enterprise: *714 - installation: *715 - issue: *739 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + issue: *744 + organization: *721 + repository: *722 sender: *4 required: - action @@ -154015,12 +156889,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *714 - installation: *715 - issue: *739 - label: *733 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + issue: *744 + label: *738 + organization: *721 + repository: *722 sender: *4 required: - action @@ -154100,8 +156974,8 @@ webhooks: type: string enum: - unlocked - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -154934,11 +157808,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *651 - issue_dependencies_summary: *652 + sub_issues_summary: *655 + issue_dependencies_summary: *656 issue_field_values: type: array - items: *534 + items: *538 state: description: State of the issue; either 'open' or 'closed' type: string @@ -154955,7 +157829,7 @@ webhooks: title: description: Title of the issue type: string - type: *232 + type: *236 updated_at: type: string format: date-time @@ -155035,8 +157909,8 @@ webhooks: format: uri user_view_type: type: string - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -155116,11 +157990,11 @@ webhooks: type: string enum: - unpinned - enterprise: *714 - installation: *715 - issue: *741 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + issue: *746 + organization: *721 + repository: *722 sender: *4 required: - action @@ -155199,12 +158073,12 @@ webhooks: type: string enum: - untyped - enterprise: *714 - installation: *715 - issue: *739 - type: *232 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + issue: *744 + type: *236 + organization: *721 + repository: *722 sender: *4 required: - action @@ -155284,11 +158158,11 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - label: *733 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + label: *738 + organization: *721 + repository: *722 sender: *4 required: - action @@ -155366,11 +158240,11 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - label: *733 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + label: *738 + organization: *721 + repository: *722 sender: *4 required: - action @@ -155480,11 +158354,11 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - label: *733 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + label: *738 + organization: *721 + repository: *722 sender: *4 required: - action @@ -155566,9 +158440,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *714 - installation: *715 - marketplace_purchase: &742 + enterprise: *719 + installation: *720 + marketplace_purchase: &747 title: Marketplace Purchase type: object required: @@ -155656,8 +158530,8 @@ webhooks: type: integer unit_count: type: integer - organization: *716 - previous_marketplace_purchase: &743 + organization: *721 + previous_marketplace_purchase: &748 title: Marketplace Purchase type: object properties: @@ -155741,7 +158615,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *717 + repository: *722 sender: *4 required: - action @@ -155821,10 +158695,10 @@ webhooks: - changed effective_date: type: string - enterprise: *714 - installation: *715 - marketplace_purchase: *742 - organization: *716 + enterprise: *719 + installation: *720 + marketplace_purchase: *747 + organization: *721 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -155912,7 +158786,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *717 + repository: *722 sender: *4 required: - action @@ -155994,10 +158868,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *714 - installation: *715 - marketplace_purchase: *742 - organization: *716 + enterprise: *719 + installation: *720 + marketplace_purchase: *747 + organization: *721 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -156083,7 +158957,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *717 + repository: *722 sender: *4 required: - action @@ -156164,8 +159038,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 marketplace_purchase: title: Marketplace Purchase type: object @@ -156251,9 +159125,9 @@ webhooks: type: integer unit_count: type: integer - organization: *716 - previous_marketplace_purchase: *743 - repository: *717 + organization: *721 + previous_marketplace_purchase: *748 + repository: *722 sender: *4 required: - action @@ -156333,12 +159207,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *714 - installation: *715 - marketplace_purchase: *742 - organization: *716 - previous_marketplace_purchase: *743 - repository: *717 + enterprise: *719 + installation: *720 + marketplace_purchase: *747 + organization: *721 + previous_marketplace_purchase: *748 + repository: *722 sender: *4 required: - action @@ -156440,11 +159314,11 @@ webhooks: type: string required: - to - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + member: *739 + organization: *721 + repository: *722 sender: *4 required: - action @@ -156546,11 +159420,11 @@ webhooks: type: - string - 'null' - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + member: *739 + organization: *721 + repository: *722 sender: *4 required: - action @@ -156629,11 +159503,11 @@ webhooks: type: string enum: - removed - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + member: *739 + organization: *721 + repository: *722 sender: *4 required: - action @@ -156711,11 +159585,11 @@ webhooks: type: string enum: - added - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + member: *739 + organization: *721 + repository: *722 scope: description: The scope of the membership. Currently, can only be `team`. @@ -156793,7 +159667,7 @@ webhooks: required: - login - id - team: &744 + team: &749 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -157023,11 +159897,11 @@ webhooks: type: string enum: - removed - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + member: *739 + organization: *721 + repository: *722 scope: description: The scope of the membership. Currently, can only be `team`. @@ -157106,7 +159980,7 @@ webhooks: required: - login - id - team: *744 + team: *749 required: - action - scope @@ -157188,8 +160062,8 @@ webhooks: type: string enum: - checks_requested - installation: *715 - merge_group: &745 + installation: *720 + merge_group: &750 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -157208,15 +160082,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *408 + head_commit: *412 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -157302,10 +160176,10 @@ webhooks: - merged - invalidated - dequeued - installation: *715 - merge_group: *745 - organization: *716 - repository: *717 + installation: *720 + merge_group: *750 + organization: *721 + repository: *722 sender: *4 required: - action @@ -157378,7 +160252,7 @@ webhooks: type: string enum: - deleted - enterprise: *714 + enterprise: *719 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -157487,12 +160361,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *715 - organization: *716 + installation: *720 + organization: *721 repository: anyOf: - type: 'null' - - *717 + - *722 sender: *4 required: - action @@ -157572,11 +160446,11 @@ webhooks: type: string enum: - closed - enterprise: *714 - installation: *715 - milestone: *740 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + milestone: *745 + organization: *721 + repository: *722 sender: *4 required: - action @@ -157655,9 +160529,9 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - milestone: &746 + enterprise: *719 + installation: *720 + milestone: &751 title: Milestone description: A collection of related issues and pull requests. type: object @@ -157799,8 +160673,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -157879,11 +160753,11 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - milestone: *740 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + milestone: *745 + organization: *721 + repository: *722 sender: *4 required: - action @@ -157993,11 +160867,11 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - milestone: *740 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + milestone: *745 + organization: *721 + repository: *722 sender: *4 required: - action @@ -158077,11 +160951,11 @@ webhooks: type: string enum: - opened - enterprise: *714 - installation: *715 - milestone: *746 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + milestone: *751 + organization: *721 + repository: *722 sender: *4 required: - action @@ -158160,11 +161034,11 @@ webhooks: type: string enum: - blocked - blocked_user: *734 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + blocked_user: *739 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -158243,11 +161117,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *734 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + blocked_user: *739 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -158326,9 +161200,9 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - membership: &747 + enterprise: *719 + installation: *720 + membership: &752 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -158438,8 +161312,8 @@ webhooks: - role - organization_url - user - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 required: - action @@ -158517,11 +161391,11 @@ webhooks: type: string enum: - member_added - enterprise: *714 - installation: *715 - membership: *747 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + membership: *752 + organization: *721 + repository: *722 sender: *4 required: - action @@ -158600,8 +161474,8 @@ webhooks: type: string enum: - member_invited - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -158723,10 +161597,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 - user: *734 + user: *739 required: - action - invitation @@ -158804,11 +161678,11 @@ webhooks: type: string enum: - member_removed - enterprise: *714 - installation: *715 - membership: *747 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + membership: *752 + organization: *721 + repository: *722 sender: *4 required: - action @@ -158895,11 +161769,11 @@ webhooks: properties: from: type: string - enterprise: *714 - installation: *715 - membership: *747 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + membership: *752 + organization: *721 + repository: *722 sender: *4 required: - action @@ -158976,9 +161850,9 @@ webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 package: description: Information about the package. type: object @@ -159501,7 +162375,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &748 + items: &753 title: Ruby Gems metadata type: object properties: @@ -159598,7 +162472,7 @@ webhooks: - owner - package_version - registry - repository: *717 + repository: *722 sender: *4 required: - action @@ -159674,9 +162548,9 @@ webhooks: type: string enum: - updated - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 package: description: Information about the package. type: object @@ -160038,7 +162912,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *748 + items: *753 source_url: type: string format: uri @@ -160109,7 +162983,7 @@ webhooks: - owner - package_version - registry - repository: *717 + repository: *722 sender: *4 required: - action @@ -160289,12 +163163,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *714 + enterprise: *719 id: type: integer - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - id @@ -160371,7 +163245,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &749 + personal_access_token_request: &754 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -160521,10 +163395,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *714 - organization: *716 + enterprise: *719 + organization: *721 sender: *4 - installation: *715 + installation: *720 required: - action - personal_access_token_request @@ -160601,11 +163475,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *749 - enterprise: *714 - organization: *716 + personal_access_token_request: *754 + enterprise: *719 + organization: *721 sender: *4 - installation: *715 + installation: *720 required: - action - personal_access_token_request @@ -160681,11 +163555,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *749 - enterprise: *714 - organization: *716 + personal_access_token_request: *754 + enterprise: *719 + organization: *721 sender: *4 - installation: *715 + installation: *720 required: - action - personal_access_token_request @@ -160760,11 +163634,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *749 - organization: *716 - enterprise: *714 + personal_access_token_request: *754 + organization: *721 + enterprise: *719 sender: *4 - installation: *715 + installation: *720 required: - action - personal_access_token_request @@ -160869,7 +163743,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *750 + last_response: *755 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -160901,8 +163775,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 zen: description: Random string of GitHub zen. @@ -161147,10 +164021,10 @@ webhooks: - from required: - note - enterprise: *714 - installation: *715 - organization: *716 - project_card: &751 + enterprise: *719 + installation: *720 + organization: *721 + project_card: &756 title: Project Card type: object properties: @@ -161273,7 +164147,7 @@ webhooks: - creator - created_at - updated_at - repository: *717 + repository: *722 sender: *4 required: - action @@ -161354,11 +164228,11 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - project_card: *751 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + project_card: *756 + repository: *722 sender: *4 required: - action @@ -161438,9 +164312,9 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 project_card: title: Project Card type: object @@ -161570,7 +164444,7 @@ webhooks: repository: anyOf: - type: 'null' - - *717 + - *722 sender: *4 required: - action @@ -161664,11 +164538,11 @@ webhooks: - from required: - note - enterprise: *714 - installation: *715 - organization: *716 - project_card: *751 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + project_card: *756 + repository: *722 sender: *4 required: - action @@ -161762,9 +164636,9 @@ webhooks: - from required: - column_id - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 project_card: allOf: - title: Project Card @@ -161961,7 +164835,7 @@ webhooks: type: string required: - after_id - repository: *717 + repository: *722 sender: *4 required: - action @@ -162041,10 +164915,10 @@ webhooks: type: string enum: - closed - enterprise: *714 - installation: *715 - organization: *716 - project: &753 + enterprise: *719 + installation: *720 + organization: *721 + project: &758 title: Project type: object properties: @@ -162171,7 +165045,7 @@ webhooks: - creator - created_at - updated_at - repository: *717 + repository: *722 sender: *4 required: - action @@ -162251,10 +165125,10 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - project_column: &752 + enterprise: *719 + installation: *720 + organization: *721 + project_column: &757 title: Project Column type: object properties: @@ -162294,7 +165168,7 @@ webhooks: - name - created_at - updated_at - repository: *717 + repository: *722 sender: *4 required: - action @@ -162373,14 +165247,14 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - project_column: *752 + enterprise: *719 + installation: *720 + organization: *721 + project_column: *757 repository: anyOf: - type: 'null' - - *717 + - *722 sender: *4 required: - action @@ -162469,11 +165343,11 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 - project_column: *752 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + project_column: *757 + repository: *722 sender: *4 required: - action @@ -162553,11 +165427,11 @@ webhooks: type: string enum: - moved - enterprise: *714 - installation: *715 - organization: *716 - project_column: *752 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + project_column: *757 + repository: *722 sender: *4 required: - action @@ -162637,11 +165511,11 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - project: *753 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + project: *758 + repository: *722 sender: *4 required: - action @@ -162721,14 +165595,14 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - project: *753 + enterprise: *719 + installation: *720 + organization: *721 + project: *758 repository: anyOf: - type: 'null' - - *717 + - *722 sender: *4 required: - action @@ -162829,11 +165703,11 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 - project: *753 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + project: *758 + repository: *722 sender: *4 required: - action @@ -162912,11 +165786,11 @@ webhooks: type: string enum: - reopened - enterprise: *714 - installation: *715 - organization: *716 - project: *753 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + project: *758 + repository: *722 sender: *4 required: - action @@ -162997,9 +165871,9 @@ webhooks: type: string enum: - closed - installation: *715 - organization: *716 - projects_v2: *265 + installation: *720 + organization: *721 + projects_v2: *269 sender: *4 required: - action @@ -163080,9 +165954,9 @@ webhooks: type: string enum: - created - installation: *715 - organization: *716 - projects_v2: *265 + installation: *720 + organization: *721 + projects_v2: *269 sender: *4 required: - action @@ -163163,9 +166037,9 @@ webhooks: type: string enum: - deleted - installation: *715 - organization: *716 - projects_v2: *265 + installation: *720 + organization: *721 + projects_v2: *269 sender: *4 required: - action @@ -163286,9 +166160,9 @@ webhooks: type: string to: type: string - installation: *715 - organization: *716 - projects_v2: *265 + installation: *720 + organization: *721 + projects_v2: *269 sender: *4 required: - action @@ -163371,7 +166245,7 @@ webhooks: type: string enum: - archived - changes: &757 + changes: &762 type: object properties: archived_at: @@ -163387,9 +166261,9 @@ webhooks: - string - 'null' format: date-time - installation: *715 - organization: *716 - projects_v2_item: &754 + installation: *720 + organization: *721 + projects_v2_item: &759 title: Projects v2 Item description: An item belonging to a project type: object @@ -163407,7 +166281,7 @@ webhooks: type: string description: The node ID of the content represented by this item. - content_type: *271 + content_type: *275 creator: *4 created_at: type: string @@ -163529,9 +166403,9 @@ webhooks: - 'null' to: type: string - installation: *715 - organization: *716 - projects_v2_item: *754 + installation: *720 + organization: *721 + projects_v2_item: *759 sender: *4 required: - action @@ -163613,9 +166487,9 @@ webhooks: type: string enum: - created - installation: *715 - organization: *716 - projects_v2_item: *754 + installation: *720 + organization: *721 + projects_v2_item: *759 sender: *4 required: - action @@ -163696,9 +166570,9 @@ webhooks: type: string enum: - deleted - installation: *715 - organization: *716 - projects_v2_item: *754 + installation: *720 + organization: *721 + projects_v2_item: *759 sender: *4 required: - action @@ -163803,7 +166677,7 @@ webhooks: oneOf: - type: string - type: integer - - &755 + - &760 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -163827,7 +166701,7 @@ webhooks: required: - id - name - - &756 + - &761 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -163867,8 +166741,8 @@ webhooks: oneOf: - type: string - type: integer - - *755 - - *756 + - *760 + - *761 type: - 'null' - string @@ -163891,9 +166765,9 @@ webhooks: - 'null' required: - body - installation: *715 - organization: *716 - projects_v2_item: *754 + installation: *720 + organization: *721 + projects_v2_item: *759 sender: *4 required: - action @@ -163990,9 +166864,9 @@ webhooks: type: - string - 'null' - installation: *715 - organization: *716 - projects_v2_item: *754 + installation: *720 + organization: *721 + projects_v2_item: *759 sender: *4 required: - action @@ -164075,10 +166949,10 @@ webhooks: type: string enum: - restored - changes: *757 - installation: *715 - organization: *716 - projects_v2_item: *754 + changes: *762 + installation: *720 + organization: *721 + projects_v2_item: *759 sender: *4 required: - action @@ -164160,9 +167034,9 @@ webhooks: type: string enum: - reopened - installation: *715 - organization: *716 - projects_v2: *265 + installation: *720 + organization: *721 + projects_v2: *269 sender: *4 required: - action @@ -164243,9 +167117,9 @@ webhooks: type: string enum: - created - installation: *715 - organization: *716 - projects_v2_status_update: *758 + installation: *720 + organization: *721 + projects_v2_status_update: *763 sender: *4 required: - action @@ -164326,9 +167200,9 @@ webhooks: type: string enum: - deleted - installation: *715 - organization: *716 - projects_v2_status_update: *758 + installation: *720 + organization: *721 + projects_v2_status_update: *763 sender: *4 required: - action @@ -164474,9 +167348,9 @@ webhooks: - string - 'null' format: date - installation: *715 - organization: *716 - projects_v2_status_update: *758 + installation: *720 + organization: *721 + projects_v2_status_update: *763 sender: *4 required: - action @@ -164547,10 +167421,10 @@ webhooks: title: public event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - repository @@ -164627,13 +167501,13 @@ webhooks: type: string enum: - assigned - assignee: *734 - enterprise: *714 - installation: *715 - number: &759 + assignee: *739 + enterprise: *719 + installation: *720 + number: &764 description: The pull request number. type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -167004,7 +169878,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -167101,11 +169975,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -169469,7 +172343,7 @@ webhooks: - draft reason: type: string - repository: *717 + repository: *722 sender: *4 required: - action @@ -169566,11 +172440,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -171934,7 +174808,7 @@ webhooks: - draft reason: type: string - repository: *717 + repository: *722 sender: *4 required: - action @@ -172031,13 +174905,13 @@ webhooks: type: string enum: - closed - enterprise: *714 - installation: *715 - number: *759 - organization: *716 - pull_request: &760 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 + pull_request: &765 allOf: - - *571 + - *575 - type: object properties: allow_auto_merge: @@ -172099,7 +174973,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *717 + repository: *722 sender: *4 required: - action @@ -172180,12 +175054,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *714 - installation: *715 - number: *759 - organization: *716 - pull_request: *760 - repository: *717 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 + pull_request: *765 + repository: *722 sender: *4 required: - action @@ -172265,11 +175139,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *714 - milestone: *268 - number: *759 - organization: *716 - pull_request: &761 + enterprise: *719 + milestone: *272 + number: *764 + organization: *721 + pull_request: &766 title: Pull Request type: object properties: @@ -174660,7 +177534,7 @@ webhooks: - active_lock_reason - draft version: '2026-03-10' - repository: *717 + repository: *722 sender: *4 required: - action @@ -174739,11 +177613,11 @@ webhooks: type: string enum: - dequeued - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -177111,7 +179985,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *717 + repository: *722 sender: *4 required: - action @@ -177243,12 +180117,12 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - number: *759 - organization: *716 - pull_request: *760 - repository: *717 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 + pull_request: *765 + repository: *722 sender: *4 required: - action @@ -177328,11 +180202,11 @@ webhooks: type: string enum: - enqueued - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -179685,7 +182559,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -179773,11 +182647,11 @@ webhooks: type: string enum: - labeled - enterprise: *714 - installation: *715 - label: *733 - number: *759 - organization: *716 + enterprise: *719 + installation: *720 + label: *738 + number: *764 + organization: *721 pull_request: title: Pull Request type: object @@ -182147,7 +185021,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -182243,10 +185117,10 @@ webhooks: type: string enum: - locked - enterprise: *714 - installation: *715 - number: *759 - organization: *716 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 pull_request: title: Pull Request type: object @@ -184614,7 +187488,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -184709,12 +187583,12 @@ webhooks: type: string enum: - milestoned - enterprise: *714 - milestone: *268 - number: *759 - organization: *716 - pull_request: *761 - repository: *717 + enterprise: *719 + milestone: *272 + number: *764 + organization: *721 + pull_request: *766 + repository: *722 sender: *4 required: - action @@ -184793,12 +187667,12 @@ webhooks: type: string enum: - opened - enterprise: *714 - installation: *715 - number: *759 - organization: *716 - pull_request: *760 - repository: *717 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 + pull_request: *765 + repository: *722 sender: *4 required: - action @@ -184879,12 +187753,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *714 - installation: *715 - number: *759 - organization: *716 - pull_request: *760 - repository: *717 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 + pull_request: *765 + repository: *722 sender: *4 required: - action @@ -184964,12 +187838,12 @@ webhooks: type: string enum: - reopened - enterprise: *714 - installation: *715 - number: *759 - organization: *716 - pull_request: *760 - repository: *717 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 + pull_request: *765 + repository: *722 sender: *4 required: - action @@ -185344,9 +188218,9 @@ webhooks: - start_side - side - reactions - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pull_request: type: object properties: @@ -187598,7 +190472,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *717 + repository: *722 sender: *4 required: - action @@ -187693,7 +190567,7 @@ webhooks: type: string enum: - deleted - comment: &763 + comment: &768 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -187986,9 +190860,9 @@ webhooks: - start_side - side - reactions - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pull_request: type: object properties: @@ -190228,7 +193102,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *717 + repository: *722 sender: *4 required: - action @@ -190323,11 +193197,11 @@ webhooks: type: string enum: - edited - changes: *762 - comment: *763 - enterprise: *714 - installation: *715 - organization: *716 + changes: *767 + comment: *768 + enterprise: *719 + installation: *720 + organization: *721 pull_request: type: object properties: @@ -192570,7 +195444,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *717 + repository: *722 sender: *4 required: - action @@ -192666,9 +195540,9 @@ webhooks: type: string enum: - dismissed - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pull_request: title: Simple Pull Request type: object @@ -194923,7 +197797,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 + repository: *722 review: description: The review that was affected. type: object @@ -195189,9 +198063,9 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pull_request: title: Simple Pull Request type: object @@ -197305,8 +200179,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 - review: &764 + repository: *722 + review: &769 description: The review that was affected. type: object properties: @@ -197552,12 +200426,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: description: The pull request number. type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -199926,7 +202800,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 requested_reviewer: title: User type: @@ -200012,12 +202886,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: description: The pull request number. type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -202393,7 +205267,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 requested_team: title: Team description: Groups of organization members that gives permissions @@ -202611,12 +205485,12 @@ webhooks: type: string enum: - review_requested - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: description: The pull request number. type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -204987,7 +207861,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 requested_reviewer: title: User type: @@ -205074,12 +207948,12 @@ webhooks: type: string enum: - review_requested - enterprise: *714 - installation: *715 + enterprise: *719 + installation: *720 number: description: The pull request number. type: integer - organization: *716 + organization: *721 pull_request: title: Pull Request type: object @@ -207441,7 +210315,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 requested_team: title: Team description: Groups of organization members that gives permissions @@ -207648,9 +210522,9 @@ webhooks: type: string enum: - submitted - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pull_request: title: Simple Pull Request type: object @@ -209908,8 +212782,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 - review: *764 + repository: *722 + review: *769 sender: *4 required: - action @@ -210004,9 +212878,9 @@ webhooks: type: string enum: - resolved - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pull_request: title: Simple Pull Request type: object @@ -212159,7 +215033,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 + repository: *722 sender: *4 thread: type: object @@ -212564,9 +215438,9 @@ webhooks: type: string enum: - unresolved - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 pull_request: title: Simple Pull Request type: object @@ -214702,7 +217576,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 + repository: *722 sender: *4 thread: type: object @@ -215109,10 +217983,10 @@ webhooks: type: string before: type: string - enterprise: *714 - installation: *715 - number: *759 - organization: *716 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 pull_request: title: Pull Request type: object @@ -217469,7 +220343,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -217566,11 +220440,11 @@ webhooks: type: string enum: - unassigned - assignee: *765 - enterprise: *714 - installation: *715 - number: *759 - organization: *716 + assignee: *770 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 pull_request: title: Pull Request type: object @@ -219942,7 +222816,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -220036,11 +222910,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *714 - installation: *715 - label: *733 - number: *759 - organization: *716 + enterprise: *719 + installation: *720 + label: *738 + number: *764 + organization: *721 pull_request: title: Pull Request type: object @@ -222401,7 +225275,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -222497,10 +225371,10 @@ webhooks: type: string enum: - unlocked - enterprise: *714 - installation: *715 - number: *759 - organization: *716 + enterprise: *719 + installation: *720 + number: *764 + organization: *721 pull_request: title: Pull Request type: object @@ -224851,7 +227725,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *722 sender: *4 required: - action @@ -225069,7 +227943,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *714 + enterprise: *719 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -225164,8 +228038,8 @@ webhooks: - url - author - committer - installation: *715 - organization: *716 + installation: *720 + organization: *721 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -225764,9 +228638,9 @@ webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 registry_package: type: object properties: @@ -226243,7 +229117,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *748 + items: *753 summary: type: string tag_name: @@ -226299,7 +229173,7 @@ webhooks: - owner - package_version - registry - repository: *717 + repository: *722 sender: *4 required: - action @@ -226377,9 +229251,9 @@ webhooks: type: string enum: - updated - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 registry_package: type: object properties: @@ -226691,7 +229565,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *748 + items: *753 summary: type: string tag_name: @@ -226741,7 +229615,7 @@ webhooks: - owner - package_version - registry - repository: *717 + repository: *722 sender: *4 required: - action @@ -226818,10 +229692,10 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - release: &766 + enterprise: *719 + installation: *720 + organization: *721 + release: &771 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -227152,7 +230026,7 @@ webhooks: - updated_at - zipball_url - body - repository: *717 + repository: *722 sender: *4 required: - action @@ -227229,11 +230103,11 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - release: *766 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + release: *771 + repository: *722 sender: *4 required: - action @@ -227350,11 +230224,11 @@ webhooks: type: boolean required: - to - enterprise: *714 - installation: *715 - organization: *716 - release: *766 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + release: *771 + repository: *722 sender: *4 required: - action @@ -227432,9 +230306,9 @@ webhooks: type: string enum: - prereleased - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -227770,7 +230644,7 @@ webhooks: - string - 'null' format: uri - repository: *717 + repository: *722 sender: *4 required: - action @@ -227846,10 +230720,10 @@ webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 - release: &767 + enterprise: *719 + installation: *720 + organization: *721 + release: &772 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -228182,7 +231056,7 @@ webhooks: - string - 'null' format: uri - repository: *717 + repository: *722 sender: *4 required: - action @@ -228258,11 +231132,11 @@ webhooks: type: string enum: - released - enterprise: *714 - installation: *715 - organization: *716 - release: *766 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + release: *771 + repository: *722 sender: *4 required: - action @@ -228338,11 +231212,11 @@ webhooks: type: string enum: - unpublished - enterprise: *714 - installation: *715 - organization: *716 - release: *767 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + release: *772 + repository: *722 sender: *4 required: - action @@ -228418,11 +231292,11 @@ webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - repository_advisory: *638 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + repository_advisory: *642 sender: *4 required: - action @@ -228498,11 +231372,11 @@ webhooks: type: string enum: - reported - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - repository_advisory: *638 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + repository_advisory: *642 sender: *4 required: - action @@ -228578,10 +231452,10 @@ webhooks: type: string enum: - archived - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -228658,10 +231532,10 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -228739,10 +231613,10 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -228827,10 +231701,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -228945,10 +231819,10 @@ webhooks: - 'null' items: type: string - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -229020,10 +231894,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 status: type: string @@ -229104,10 +231978,10 @@ webhooks: type: string enum: - privatized - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -229184,10 +232058,10 @@ webhooks: type: string enum: - publicized - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -229281,10 +232155,10 @@ webhooks: - name required: - repository - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -229364,11 +232238,11 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - repository_ruleset: *310 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + repository_ruleset: *314 sender: *4 required: - action @@ -229446,11 +232320,11 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - repository_ruleset: *310 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + repository_ruleset: *314 sender: *4 required: - action @@ -229528,11 +232402,11 @@ webhooks: type: string enum: - edited - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - repository_ruleset: *310 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + repository_ruleset: *314 changes: type: object properties: @@ -229551,16 +232425,16 @@ webhooks: properties: added: type: array - items: *284 + items: *288 deleted: type: array - items: *284 + items: *288 updated: type: array items: type: object properties: - condition: *284 + condition: *288 changes: type: object properties: @@ -229593,16 +232467,16 @@ webhooks: properties: added: type: array - items: *591 + items: *595 deleted: type: array - items: *591 + items: *595 updated: type: array items: type: object properties: - rule: *591 + rule: *595 changes: type: object properties: @@ -229839,10 +232713,10 @@ webhooks: - from required: - owner - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -229920,10 +232794,10 @@ webhooks: type: string enum: - unarchived - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -230001,7 +232875,7 @@ webhooks: type: string enum: - create - alert: &768 + alert: &773 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -230126,10 +233000,10 @@ webhooks: enum: - auto_dismissed - open - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -230339,10 +233213,10 @@ webhooks: type: string enum: - dismissed - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -230420,11 +233294,11 @@ webhooks: type: string enum: - reopen - alert: *768 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *773 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -230626,10 +233500,10 @@ webhooks: enum: - fixed - open - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -230707,7 +233581,7 @@ webhooks: type: string enum: - assigned - alert: &769 + alert: &774 type: object properties: number: *171 @@ -230847,10 +233721,10 @@ webhooks: - type: 'null' - *4 assignee: *4 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -230928,11 +233802,11 @@ webhooks: type: string enum: - created - alert: *769 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *774 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -231013,11 +233887,11 @@ webhooks: type: string enum: - created - alert: *769 - installation: *715 - location: *770 - organization: *716 - repository: *717 + alert: *774 + installation: *720 + location: *775 + organization: *721 + repository: *722 sender: *4 required: - location @@ -231255,11 +234129,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *769 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *774 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -231337,11 +234211,11 @@ webhooks: type: string enum: - reopened - alert: *769 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *774 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -231419,11 +234293,11 @@ webhooks: type: string enum: - resolved - alert: *769 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *774 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -231501,12 +234375,12 @@ webhooks: type: string enum: - unassigned - alert: *769 + alert: *774 assignee: *4 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -231584,11 +234458,11 @@ webhooks: type: string enum: - validated - alert: *769 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *774 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -231718,10 +234592,10 @@ webhooks: - organization - enterprise - - repository: *717 - enterprise: *714 - installation: *715 - organization: *716 + repository: *722 + enterprise: *719 + installation: *720 + organization: *721 sender: *4 required: - action @@ -231799,11 +234673,11 @@ webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - security_advisory: &771 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + security_advisory: &776 description: The details of the security advisory, including summary, description, and severity. type: object @@ -232007,11 +234881,11 @@ webhooks: type: string enum: - updated - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - security_advisory: *771 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 + security_advisory: *776 sender: *4 required: - action @@ -232084,10 +234958,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -232281,11 +235155,11 @@ webhooks: from: type: object properties: - security_and_analysis: *283 - enterprise: *714 - installation: *715 - organization: *716 - repository: *330 + security_and_analysis: *287 + enterprise: *719 + installation: *720 + organization: *721 + repository: *334 sender: *4 required: - changes @@ -232363,12 +235237,12 @@ webhooks: type: string enum: - cancelled - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - sponsorship: &772 + sponsorship: &777 type: object properties: created_at: @@ -232673,12 +235547,12 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - sponsorship: *772 + sponsorship: *777 required: - action - sponsorship @@ -232766,12 +235640,12 @@ webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - sponsorship: *772 + sponsorship: *777 required: - action - changes @@ -232848,17 +235722,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &773 + effective_date: &778 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - sponsorship: *772 + sponsorship: *777 required: - action - sponsorship @@ -232932,7 +235806,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &774 + changes: &779 type: object properties: tier: @@ -232976,13 +235850,13 @@ webhooks: - from required: - tier - effective_date: *773 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + effective_date: *778 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - sponsorship: *772 + sponsorship: *777 required: - action - changes @@ -233059,13 +235933,13 @@ webhooks: type: string enum: - tier_changed - changes: *774 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + changes: *779 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - sponsorship: *772 + sponsorship: *777 required: - action - changes @@ -233139,10 +236013,10 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -233226,10 +236100,10 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -233663,15 +236537,15 @@ webhooks: type: - string - 'null' - enterprise: *714 + enterprise: *719 id: description: The unique identifier of the status. type: integer - installation: *715 + installation: *720 name: type: string - organization: *716 - repository: *717 + organization: *721 + repository: *722 sender: *4 sha: description: The Commit SHA. @@ -233787,9 +236661,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -233879,9 +236753,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -233971,9 +236845,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -234063,9 +236937,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -234142,12 +237016,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - team: &775 + team: &780 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -234377,9 +237251,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 repository: title: Repository description: A git repository @@ -234849,7 +237723,7 @@ webhooks: - topics - visibility sender: *4 - team: *775 + team: *780 required: - action - team @@ -234925,9 +237799,9 @@ webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 repository: title: Repository description: A git repository @@ -235397,7 +238271,7 @@ webhooks: - topics - visibility sender: *4 - team: *775 + team: *780 required: - action - team @@ -235474,9 +238348,9 @@ webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 repository: title: Repository description: A git repository @@ -235946,7 +238820,7 @@ webhooks: - topics - visibility sender: *4 - team: *775 + team: *780 required: - action - team @@ -236090,9 +238964,9 @@ webhooks: - from required: - permissions - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 repository: title: Repository description: A git repository @@ -236562,7 +239436,7 @@ webhooks: - topics - visibility sender: *4 - team: *775 + team: *780 required: - action - changes @@ -236640,9 +239514,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *719 + installation: *720 + organization: *721 repository: title: Repository description: A git repository @@ -237112,7 +239986,7 @@ webhooks: - topics - visibility sender: *4 - team: *775 + team: *780 required: - action - team @@ -237188,10 +240062,10 @@ webhooks: type: string enum: - started - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 required: - action @@ -237264,17 +240138,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *714 + enterprise: *719 inputs: type: - object - 'null' additionalProperties: true - installation: *715 - organization: *716 + installation: *720 + organization: *721 ref: type: string - repository: *717 + repository: *722 sender: *4 workflow: type: string @@ -237356,10 +240230,10 @@ webhooks: type: string enum: - completed - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 workflow_job: allOf: @@ -237615,7 +240489,7 @@ webhooks: type: string required: - conclusion - deployment: *486 + deployment: *490 required: - action - repository @@ -237694,10 +240568,10 @@ webhooks: type: string enum: - in_progress - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 workflow_job: allOf: @@ -237979,7 +240853,7 @@ webhooks: required: - status - steps - deployment: *486 + deployment: *490 required: - action - repository @@ -238058,10 +240932,10 @@ webhooks: type: string enum: - queued - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 workflow_job: type: object @@ -238207,7 +241081,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *486 + deployment: *490 required: - action - repository @@ -238286,10 +241160,10 @@ webhooks: type: string enum: - waiting - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 workflow_job: type: object @@ -238436,7 +241310,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *486 + deployment: *490 required: - action - repository @@ -238516,12 +241390,12 @@ webhooks: type: string enum: - completed - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - workflow: *729 + workflow: *734 workflow_run: title: Workflow Run type: object @@ -239540,12 +242414,12 @@ webhooks: type: string enum: - in_progress - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - workflow: *729 + workflow: *734 workflow_run: title: Workflow Run type: object @@ -240549,12 +243423,12 @@ webhooks: type: string enum: - requested - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *719 + installation: *720 + organization: *721 + repository: *722 sender: *4 - workflow: *729 + workflow: *734 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index 1d52e49f81..540dc227f7 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -136,6 +136,10 @@ "name": "users", "description": "Interact with and view information about users and also current user." }, + { + "name": "code-quality", + "description": "Insights into reliability, maintainability, and efficiency of your codebase." + }, { "name": "codespaces", "description": "Endpoints to manage Codespaces using the REST API." @@ -144,6 +148,10 @@ "name": "copilot", "description": "Endpoints to manage Copilot using the REST API." }, + { + "name": "copilot-spaces", + "description": "Endpoints to manage Copilot Spaces using the REST API." + }, { "name": "enterprise-admin", "description": "Enterprise Administration" @@ -462,21 +470,21 @@ }, "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#github-api-root" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/meta/meta#github-api-root" } } }, "/advisories": { "get": { "summary": "List global security advisories", - "description": "Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.\n\nBy default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see \"[About the GitHub Advisory database](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories).\"", + "description": "Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.\n\nBy default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see \"[About the GitHub Advisory database](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories).\"", "tags": [ "security-advisories" ], "operationId": "security-advisories/list-global-advisories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#list-global-security-advisories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories#list-global-security-advisories" }, "parameters": [ { @@ -596,7 +604,7 @@ { "name": "published", "in": "query", - "description": "If specified, only return advisories that were published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "description": "If specified, only return advisories that were published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", "schema": { "type": "string" } @@ -604,14 +612,14 @@ { "name": "updated", "in": "query", - "description": "If specified, only return advisories that were updated on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "description": "If specified, only return advisories that were updated on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", "schema": { "type": "string" } }, { "name": "modified", - "description": "If specified, only show advisories that were updated or published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "description": "If specified, only show advisories that were updated or published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", "in": "query", "schema": { "type": "string" @@ -635,7 +643,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -644,7 +652,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -667,7 +675,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -1483,7 +1491,7 @@ "operationId": "security-advisories/get-global-advisory", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories#get-a-global-security-advisory" }, "parameters": [ { @@ -2239,14 +2247,14 @@ "/app": { "get": { "summary": "Get the authenticated app", - "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-authenticated", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-the-authenticated-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-the-authenticated-app" }, "parameters": [], "responses": { @@ -2716,14 +2724,14 @@ "/app-manifests/{code}/conversions": { "post": { "summary": "Create a GitHub App from a manifest", - "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", + "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", "tags": [ "apps" ], "operationId": "apps/create-from-manifest", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-a-github-app-from-a-manifest" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#create-a-github-app-from-a-manifest" }, "parameters": [ { @@ -3292,14 +3300,14 @@ "/app/hook/config": { "get": { "summary": "Get a webhook configuration for an app", - "description": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-webhook-config-for-app", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#get-a-webhook-configuration-for-an-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/webhooks#get-a-webhook-configuration-for-an-app" }, "responses": { "200": { @@ -3328,7 +3336,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -3372,14 +3380,14 @@ }, "patch": { "summary": "Update a webhook configuration for an app", - "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/update-webhook-config-for-app", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#update-a-webhook-configuration-for-an-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/webhooks#update-a-webhook-configuration-for-an-app" }, "requestBody": { "required": true, @@ -3405,7 +3413,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -3466,7 +3474,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -3512,19 +3520,19 @@ "/app/hook/deliveries": { "get": { "summary": "List deliveries for an app webhook", - "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/list-webhook-deliveries", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#list-deliveries-for-an-app-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/webhooks#list-deliveries-for-an-app-webhook" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -3875,14 +3883,14 @@ "/app/hook/deliveries/{delivery_id}": { "get": { "summary": "Get a delivery for an app webhook", - "description": "Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#get-a-delivery-for-an-app-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/webhooks#get-a-delivery-for-an-app-webhook" }, "parameters": [ { @@ -4282,14 +4290,14 @@ "/app/hook/deliveries/{delivery_id}/attempts": { "post": { "summary": "Redeliver a delivery for an app webhook", - "description": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/redeliver-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook" }, "parameters": [ { @@ -4479,12 +4487,12 @@ "operationId": "apps/list-installation-requests-for-authenticated-app", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#list-installation-requests-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#list-installation-requests-for-the-authenticated-app" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -4493,7 +4501,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -5066,19 +5074,19 @@ "/app/installations": { "get": { "summary": "List installations for the authenticated app", - "description": "The permissions the installation has are included under the `permissions` key.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "The permissions the installation has are included under the `permissions` key.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/list-installations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#list-installations-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#list-installations-for-the-authenticated-app" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -5087,7 +5095,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -5728,7 +5736,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -6246,14 +6254,14 @@ "/app/installations/{installation_id}": { "get": { "summary": "Get an installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-installation-for-the-authenticated-app" }, "parameters": [ { @@ -6884,7 +6892,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -7415,14 +7423,14 @@ }, "delete": { "summary": "Delete an installation for the authenticated app", - "description": "Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/delete-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#delete-an-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#delete-an-installation-for-the-authenticated-app" }, "parameters": [ { @@ -7482,14 +7490,14 @@ "/app/installations/{installation_id}/access_tokens": { "post": { "summary": "Create an installation access token for an app", - "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an enterprise, organization, or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.\n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.\n\nEnterprise account installations do not have access to repositories and cannot be scoped down using the `permissions` parameter.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an enterprise, organization, or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.\n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.\n\nEnterprise account installations do not have access to repositories and cannot be scoped down using the `permissions` parameter.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/create-installation-access-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-an-installation-access-token-for-an-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#create-an-installation-access-token-for-an-app" }, "parameters": [ { @@ -7813,7 +7821,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -8307,7 +8315,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -9800,14 +9808,14 @@ "/app/installations/{installation_id}/suspended": { "put": { "summary": "Suspend an app installation", - "description": "Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Cloud API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Cloud API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/suspend-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#suspend-an-app-installation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#suspend-an-app-installation" }, "parameters": [ { @@ -9865,14 +9873,14 @@ }, "delete": { "summary": "Unsuspend an app installation", - "description": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/unsuspend-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#unsuspend-an-app-installation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#unsuspend-an-app-installation" }, "parameters": [ { @@ -9939,7 +9947,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/oauth-applications#delete-an-app-authorization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/oauth-applications#delete-an-app-authorization" }, "parameters": [ { @@ -10081,7 +10089,7 @@ "operationId": "apps/check-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/oauth-applications#check-a-token" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/oauth-applications#check-a-token" }, "parameters": [ { @@ -10678,7 +10686,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -11269,7 +11277,7 @@ "operationId": "apps/reset-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/oauth-applications#reset-a-token" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/oauth-applications#reset-a-token" }, "parameters": [ { @@ -11866,7 +11874,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -12431,7 +12439,7 @@ "operationId": "apps/delete-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/oauth-applications#delete-an-app-token" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/oauth-applications#delete-an-app-token" }, "parameters": [ { @@ -12573,7 +12581,7 @@ "operationId": "apps/scope-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-a-scoped-access-token" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#create-a-scoped-access-token" }, "parameters": [ { @@ -12918,7 +12926,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -13673,7 +13681,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -14347,7 +14355,7 @@ "operationId": "apps/get-by-slug", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-app" }, "parameters": [ { @@ -14885,7 +14893,7 @@ "operationId": "classroom/get-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#get-an-assignment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#get-an-assignment" }, "parameters": [ { @@ -15300,7 +15308,7 @@ "operationId": "classroom/list-accepted-assignments-for-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#list-accepted-assignments-for-an-assignment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#list-accepted-assignments-for-an-assignment" }, "parameters": [ { @@ -15314,7 +15322,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -15323,7 +15331,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -15759,7 +15767,7 @@ "operationId": "classroom/get-assignment-grades", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#get-assignment-grades" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#get-assignment-grades" }, "parameters": [ { @@ -15922,12 +15930,12 @@ "operationId": "classroom/list-classrooms", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#list-classrooms" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#list-classrooms" }, "parameters": [ { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -15936,7 +15944,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -16024,7 +16032,7 @@ "operationId": "classroom/get-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#get-a-classroom" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#get-a-classroom" }, "parameters": [ { @@ -16204,7 +16212,7 @@ "operationId": "classroom/list-assignments-for-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#list-assignments-for-a-classroom" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#list-assignments-for-a-classroom" }, "parameters": [ { @@ -16218,7 +16226,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -16227,7 +16235,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -16492,7 +16500,7 @@ "operationId": "codes-of-conduct/get-all-codes-of-conduct", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct" }, "parameters": [], "responses": { @@ -16591,7 +16599,7 @@ "operationId": "codes-of-conduct/get-conduct-code", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct" }, "parameters": [ { @@ -16715,7 +16723,7 @@ "operationId": "credentials/revoke", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/credentials/revoke#revoke-a-list-of-credentials" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/credentials/revoke#revoke-a-list-of-credentials" }, "requestBody": { "required": true, @@ -16845,7 +16853,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/emojis/emojis#get-emojis" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/emojis/emojis#get-emojis" }, "parameters": [], "responses": { @@ -18767,7 +18775,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/admin-stats#get-github-enterprise-server-statistics" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/admin-stats#get-github-enterprise-server-statistics" }, "parameters": [ { @@ -18781,7 +18789,7 @@ }, { "name": "date_start", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor.", "in": "query", "required": false, "schema": { @@ -18790,7 +18798,7 @@ }, { "name": "date_end", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor.", "in": "query", "required": false, "schema": { @@ -19216,7 +19224,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprises#disable-access-restrictions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprises#disable-access-restrictions-for-an-enterprise" }, "parameters": [ { @@ -19370,7 +19378,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprises#enable-access-restrictions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprises#enable-access-restrictions-for-an-enterprise" }, "parameters": [ { @@ -19524,7 +19532,7 @@ "operationId": "actions/get-actions-cache-retention-limit-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise" }, "parameters": [ { @@ -19635,7 +19643,7 @@ "operationId": "actions/set-actions-cache-retention-limit-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise" }, "parameters": [ { @@ -19819,7 +19827,7 @@ "operationId": "actions/get-actions-cache-storage-limit-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise" }, "parameters": [ { @@ -19930,7 +19938,7 @@ "operationId": "actions/set-actions-cache-storage-limit-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise" }, "parameters": [ { @@ -20114,7 +20122,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-usage-for-an-enterprise" }, "parameters": [ { @@ -20187,7 +20195,7 @@ "operationId": "actions/list-hosted-runners-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-github-hosted-runners-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-github-hosted-runners-for-an-enterprise" }, "parameters": [ { @@ -20201,7 +20209,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -20210,7 +20218,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -20541,7 +20549,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -20915,7 +20923,7 @@ "operationId": "actions/list-custom-images-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-custom-images-for-an-enterprise" }, "parameters": [ { @@ -21064,7 +21072,7 @@ "operationId": "actions/get-custom-image-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-enterprise-custom-image-definition-for-github-actions-hosted-runners" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-an-enterprise-custom-image-definition-for-github-actions-hosted-runners" }, "parameters": [ { @@ -21198,7 +21206,7 @@ "operationId": "actions/delete-custom-image-from-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-a-custom-image-from-the-enterprise" }, "parameters": [ { @@ -21243,7 +21251,7 @@ "operationId": "actions/list-custom-image-versions-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-enterprise" }, "parameters": [ { @@ -21377,7 +21385,7 @@ "operationId": "actions/get-custom-image-version-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-an-enterprise-custom-image-for-github-actions-hosted-runners" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-an-image-version-of-an-enterprise-custom-image-for-github-actions-hosted-runners" }, "parameters": [ { @@ -21493,7 +21501,7 @@ "operationId": "actions/delete-custom-image-version-from-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-enterprise" }, "parameters": [ { @@ -21548,7 +21556,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-enterprise" }, "parameters": [ { @@ -21665,7 +21673,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-enterprise" }, "parameters": [ { @@ -21782,7 +21790,7 @@ "operationId": "actions/get-hosted-runners-limits-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-enterprise" }, "parameters": [ { @@ -21865,7 +21873,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-enterprise" }, "parameters": [ { @@ -21971,7 +21979,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-enterprise" }, "parameters": [ { @@ -22040,7 +22048,7 @@ "operationId": "actions/get-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -22344,7 +22352,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -22706,7 +22714,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -23004,7 +23012,7 @@ "operationId": "actions/set-actions-oidc-custom-issuer-policy-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-github-actions-oidc-custom-issuer-policy-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#set-the-github-actions-oidc-custom-issuer-policy-for-an-enterprise" }, "parameters": [ { @@ -23066,7 +23074,7 @@ "operationId": "oidc/list-oidc-custom-property-inclusions-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-enterprise" }, "parameters": [ { @@ -23199,7 +23207,7 @@ "operationId": "oidc/create-oidc-custom-property-inclusion-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-enterprise" }, "parameters": [ { @@ -23332,7 +23340,7 @@ "operationId": "oidc/delete-oidc-custom-property-inclusion-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-enterprise" }, "parameters": [ { @@ -23409,7 +23417,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-github-actions-permissions-for-an-enterprise" }, "parameters": [ { @@ -23495,7 +23503,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-github-actions-permissions-for-an-enterprise" }, "parameters": [ { @@ -23577,7 +23585,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-enterprise" }, "parameters": [ { @@ -23670,7 +23678,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-enterprise" }, "parameters": [ { @@ -23834,7 +23842,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-enterprise" }, "parameters": [ { @@ -23922,7 +23930,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-enterprise" }, "parameters": [ { @@ -24091,7 +24099,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-enterprise" }, "parameters": [ { @@ -24192,7 +24200,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-enterprise" }, "parameters": [ { @@ -24370,7 +24378,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise" }, "parameters": [ { @@ -24384,7 +24392,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -24393,7 +24401,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -24563,7 +24571,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise" }, "parameters": [ { @@ -24632,7 +24640,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise" }, "parameters": [ { @@ -24675,7 +24683,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise" }, "parameters": [ { @@ -24720,7 +24728,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-enterprise" }, "parameters": [ { @@ -24790,7 +24798,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-enterprise" }, "parameters": [ { @@ -24865,7 +24873,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-self-hosted-runners-permissions-for-an-enterprise" }, "parameters": [ { @@ -24948,7 +24956,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-self-hosted-runners-permissions-for-an-enterprise" }, "parameters": [ { @@ -25105,14 +25113,14 @@ "/enterprises/{enterprise}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for an enterprise", - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-github-actions-default-workflow-permissions-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-default-workflow-permissions-for-an-enterprise" }, "parameters": [ { @@ -25173,14 +25181,14 @@ }, "put": { "summary": "Set default workflow permissions for an enterprise", - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/set-github-actions-default-workflow-permissions-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-default-workflow-permissions-for-an-enterprise" }, "parameters": [ { @@ -25249,7 +25257,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise" }, "parameters": [ { @@ -25263,7 +25271,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -25272,7 +25280,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -25438,7 +25446,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-enterprise" }, "parameters": [ { @@ -25644,7 +25652,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise" }, "parameters": [ { @@ -25773,7 +25781,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise" }, "parameters": [ { @@ -25963,7 +25971,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise" }, "parameters": [ { @@ -26008,7 +26016,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" }, "parameters": [ { @@ -26031,7 +26039,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -26040,7 +26048,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -26210,7 +26218,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise" }, "parameters": [ { @@ -26288,7 +26296,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" }, "parameters": [ { @@ -26340,7 +26348,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" }, "parameters": [ { @@ -26394,7 +26402,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise" }, "parameters": [ { @@ -26417,7 +26425,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -26426,7 +26434,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -26631,7 +26639,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise" }, "parameters": [ { @@ -26709,7 +26717,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise" }, "parameters": [ { @@ -26761,7 +26769,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise" }, "parameters": [ { @@ -26815,7 +26823,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise" }, "parameters": [ { @@ -26837,7 +26845,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -26846,7 +26854,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -27049,7 +27057,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-runner-applications-for-an-enterprise" }, "parameters": [ { @@ -27160,7 +27168,7 @@ "operationId": "actions/generate-runner-jitconfig-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-enterprise" }, "parameters": [ { @@ -27470,7 +27478,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-registration-token-for-an-enterprise" }, "parameters": [ { @@ -28542,7 +28550,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-remove-token-for-an-enterprise" }, "parameters": [ { @@ -29614,7 +29622,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -29780,7 +29788,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise" }, "parameters": [ { @@ -29855,7 +29863,7 @@ "operationId": "enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -29998,7 +30006,7 @@ "operationId": "enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -30205,7 +30213,7 @@ "operationId": "enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -30412,7 +30420,7 @@ "operationId": "enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -30582,7 +30590,7 @@ "operationId": "enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -30766,7 +30774,7 @@ "operationId": "announcement-banners/get-announcement-banner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/enterprises#get-announcement-banner-for-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/enterprises#get-announcement-banner-for-enterprise" }, "parameters": [ { @@ -30794,7 +30802,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", "examples": [ "Very **important** announcement about _something_." ] @@ -30858,7 +30866,7 @@ "operationId": "announcement-banners/set-announcement-banner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/enterprises#set-announcement-banner-for-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/enterprises#set-announcement-banner-for-enterprise" }, "requestBody": { "required": true, @@ -30874,7 +30882,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", "examples": [ "Very **important** announcement about _something_." ] @@ -30945,7 +30953,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", "examples": [ "Very **important** announcement about _something_." ] @@ -31009,7 +31017,7 @@ "operationId": "announcement-banners/remove-announcement-banner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/enterprises#remove-announcement-banner-from-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/enterprises#remove-announcement-banner-from-enterprise" }, "parameters": [ { @@ -31045,7 +31053,7 @@ "operationId": "enterprise-apps/installable-organizations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-enterprise-owned-organizations-that-can-have-github-apps-installed" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#get-enterprise-owned-organizations-that-can-have-github-apps-installed" }, "parameters": [ { @@ -31059,7 +31067,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -31068,7 +31076,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -31150,7 +31158,7 @@ "operationId": "enterprise-apps/installable-organization-accessible-repositories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-repositories-belonging-to-an-enterprise-owned-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#get-repositories-belonging-to-an-enterprise-owned-organization" }, "parameters": [ { @@ -31173,7 +31181,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -31182,7 +31190,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -31269,7 +31277,7 @@ "operationId": "enterprise-apps/organization-installations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#list-github-apps-installed-on-an-enterprise-owned-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#list-github-apps-installed-on-an-enterprise-owned-organization" }, "parameters": [ { @@ -31292,7 +31300,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -31301,7 +31309,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -31634,7 +31642,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -31886,7 +31894,7 @@ "operationId": "enterprise-apps/create-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#install-a-github-app-on-an-enterprise-owned-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#install-a-github-app-on-an-enterprise-owned-organization" }, "parameters": [ { @@ -32521,7 +32529,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -33628,7 +33636,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -34198,7 +34206,7 @@ "operationId": "enterprise-apps/delete-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#uninstall-a-github-app-from-an-enterprise-owned-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#uninstall-a-github-app-from-an-enterprise-owned-organization" }, "parameters": [ { @@ -34309,7 +34317,7 @@ "operationId": "enterprise-apps/organization-installation-repositories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-the-repositories-accessible-to-a-given-github-app-installation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#get-the-repositories-accessible-to-a-given-github-app-installation" }, "parameters": [ { @@ -34346,7 +34354,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -34355,7 +34363,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -34440,7 +34448,7 @@ "operationId": "enterprise-apps/change-installation-repository-access-selection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#toggle-installation-repository-access-between-selected-and-all-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#toggle-installation-repository-access-between-selected-and-all-repositories" }, "parameters": [ { @@ -35132,7 +35140,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -35646,7 +35654,7 @@ "operationId": "enterprise-apps/grant-repository-access-to-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#grant-repository-access-to-an-organization-installation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#grant-repository-access-to-an-organization-installation" }, "parameters": [ { @@ -35794,7 +35802,7 @@ "operationId": "enterprise-apps/remove-repository-access-to-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#remove-repository-access-from-an-organization-installation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#remove-repository-access-from-an-organization-installation" }, "parameters": [ { @@ -35977,13 +35985,13 @@ "get": { "summary": "Get the audit log for an enterprise", "operationId": "enterprise-admin/get-audit-log", - "description": "Gets the audit log for an enterprise.\n\nThis endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api)\" and \"[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators).\"\n\nThe authenticated user must be an enterprise admin to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", + "description": "Gets the audit log for an enterprise.\n\nThis endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api)\" and \"[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-integrators).\"\n\nThe authenticated user must be an enterprise admin to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#get-the-audit-log-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#get-the-audit-log-for-an-enterprise" }, "parameters": [ { @@ -35997,7 +36005,7 @@ }, { "name": "phrase", - "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log).", + "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log).", "in": "query", "required": false, "schema": { @@ -36020,7 +36028,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor.", "in": "query", "required": false, "schema": { @@ -36029,7 +36037,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor.", "in": "query", "required": false, "schema": { @@ -36051,7 +36059,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -36060,7 +36068,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -36297,7 +36305,7 @@ "operationId": "enterprise-admin/get-audit-log-stream-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#get-the-audit-log-stream-key-for-encrypting-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#get-the-audit-log-stream-key-for-encrypting-secrets" }, "parameters": [ { @@ -36362,7 +36370,7 @@ "operationId": "enterprise-admin/get-audit-log-streams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#list-audit-log-stream-configurations-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#list-audit-log-stream-configurations-for-an-enterprise" }, "parameters": [ { @@ -36460,7 +36468,7 @@ "operationId": "enterprise-admin/create-audit-log-stream", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#create-an-audit-log-streaming-configuration-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#create-an-audit-log-streaming-configuration-for-an-enterprise" }, "parameters": [ { @@ -36861,7 +36869,7 @@ "operationId": "enterprise-admin/get-one-audit-log-stream", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#list-one-audit-log-streaming-configuration-via-a-stream-id" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#list-one-audit-log-streaming-configuration-via-a-stream-id" }, "parameters": [ { @@ -36963,7 +36971,7 @@ "operationId": "enterprise-admin/update-audit-log-stream", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#update-an-existing-audit-log-stream-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#update-an-existing-audit-log-stream-configuration" }, "parameters": [ { @@ -37389,7 +37397,7 @@ "operationId": "enterprise-admin/delete-audit-log-stream", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#delete-an-audit-log-streaming-configuration-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#delete-an-audit-log-streaming-configuration-for-an-enterprise" }, "parameters": [ { @@ -37434,7 +37442,7 @@ "operationId": "enterprise-admin/list-push-bypass-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/bypass-requests#list-push-rule-bypass-requests-within-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/bypass-requests#list-push-rule-bypass-requests-within-an-enterprise" }, "x-github": { "githubCloudOnly": true, @@ -37516,7 +37524,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -37525,7 +37533,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -37910,7 +37918,7 @@ "operationId": "secret-scanning/list-enterprise-bypass-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-enterprise" }, "x-github": { "githubCloudOnly": true, @@ -37992,7 +38000,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -38001,7 +38009,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -38368,14 +38376,14 @@ "/enterprises/{enterprise}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for an enterprise", - "description": "Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint.", + "description": "Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint.", "tags": [ "code-scanning" ], "operationId": "code-scanning/list-alerts-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise" }, "parameters": [ { @@ -38412,7 +38420,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -38421,7 +38429,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -38430,7 +38438,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -38439,7 +38447,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -40208,7 +40216,7 @@ "operationId": "code-security/get-configurations-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise" }, "parameters": [ { @@ -40223,7 +40231,7 @@ { "name": "per_page", "in": "query", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "required": false, "schema": { "type": "integer", @@ -40232,7 +40240,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -40241,7 +40249,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -40703,7 +40711,7 @@ "operationId": "code-security/create-configuration-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise" }, "parameters": [ { @@ -41475,7 +41483,7 @@ "operationId": "code-security/get-default-configurations-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise" }, "parameters": [ { @@ -41919,7 +41927,7 @@ "operationId": "code-security/get-single-configuration-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise" }, "parameters": [ { @@ -42364,7 +42372,7 @@ "operationId": "code-security/update-enterprise-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise" }, "parameters": [ { @@ -43084,7 +43092,7 @@ "operationId": "code-security/delete-configuration-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise" }, "parameters": [ { @@ -43275,7 +43283,7 @@ "operationId": "code-security/attach-enterprise-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories" }, "parameters": [ { @@ -43442,7 +43450,7 @@ "operationId": "code-security/set-configuration-as-default-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise" }, "parameters": [ { @@ -43952,7 +43960,7 @@ "operationId": "code-security/get-repositories-for-enterprise-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration" }, "parameters": [ { @@ -43975,7 +43983,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -43985,7 +43993,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -43994,7 +44002,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -44739,14 +44747,14 @@ "/enterprises/{enterprise}/code_security_and_analysis": { "get": { "summary": "Get code security and analysis features for an enterprise", - "description": "> [!WARNING]\n> **Closing down notice:** The ability to fetch code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nGets code security and analysis settings for the specified enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** The ability to fetch code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nGets code security and analysis settings for the specified enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], "operationId": "secret-scanning/get-security-analysis-settings-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/code-security-and-analysis#get-code-security-and-analysis-features-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/code-security-and-analysis#get-code-security-and-analysis-features-for-an-enterprise" }, "parameters": [ { @@ -44890,14 +44898,14 @@ }, "patch": { "summary": "Update code security and analysis features for an enterprise", - "description": "> [!WARNING]\n> **Closing down notice:** The ability to update code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nUpdates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** The ability to update code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nUpdates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], "operationId": "secret-scanning/patch-security-analysis-settings-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/code-security-and-analysis#update-code-security-and-analysis-features-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/code-security-and-analysis#update-code-security-and-analysis-features-for-an-enterprise" }, "parameters": [ { @@ -44919,30 +44927,30 @@ "properties": { "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security).\"" + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest/get-started/learning-about-github/about-github-advanced-security).\"" }, "advanced_security_enabled_new_user_namespace_repos": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security).\"" + "description": "Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest/get-started/learning-about-github/about-github-advanced-security).\"" }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether Dependabot alerts are automatically enabled for new repositories. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"" + "description": "Whether Dependabot alerts are automatically enabled for new repositories. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"" }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories. For more information, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\"" + "description": "Whether secret scanning is automatically enabled for new repositories. For more information, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\"" }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"" + "description": "Whether secret scanning push protection is automatically enabled for new repositories. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"" }, "secret_scanning_push_protection_custom_link": { "type": [ "string", "null" ], - "description": "The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"\nTo disable this functionality, set this field to `null`." + "description": "The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"\nTo disable this functionality, set this field to `null`." }, "secret_scanning_non_provider_patterns_enabled_for_new_repositories": { "type": [ @@ -45024,7 +45032,7 @@ "operationId": "enterprise-admin/get-consumed-licenses", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#list-enterprise-consumed-licenses" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/licensing#list-enterprise-consumed-licenses" }, "parameters": [ { @@ -45038,7 +45046,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -45047,7 +45055,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -45268,14 +45276,14 @@ "/enterprises/{enterprise}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data).\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/reference/metrics-data).\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/list-copilot-seats-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-enterprise" }, "parameters": [ { @@ -45289,7 +45297,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -45298,7 +45306,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -46231,7 +46239,7 @@ "operationId": "copilot/add-copilot-seats-for-enterprise-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-enterprise-teams-to-the-copilot-subscription-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#add-enterprise-teams-to-the-copilot-subscription-for-an-enterprise" }, "parameters": [ { @@ -46429,7 +46437,7 @@ "operationId": "copilot/cancel-copilot-seats-for-enterprise-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-enterprise-teams-from-the-copilot-subscription-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#remove-enterprise-teams-from-the-copilot-subscription-for-an-enterprise" }, "parameters": [ { @@ -46651,7 +46659,7 @@ "operationId": "copilot/add-copilot-seats-for-enterprise-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-enterprise" }, "parameters": [ { @@ -46849,7 +46857,7 @@ "operationId": "copilot/cancel-copilot-seats-for-enterprise-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-enterprise" }, "parameters": [ { @@ -47042,14 +47050,14 @@ "/enterprises/{enterprise}/copilot/content_exclusion": { "get": { "summary": "Get Copilot content exclusion rules for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an enterprise's Copilot content exclusion path rules.\nTo configure these settings, go to the enterprise's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-enterprise).\"\n\nEnterprise owners can view details about Copilot content exclusion rules for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `read:enterprise` or `copilot` scopes to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.\n> * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an enterprise's Copilot content exclusion path rules.\nTo configure these settings, go to the enterprise's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-enterprise).\"\n\nEnterprise owners can view details about Copilot content exclusion rules for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `read:enterprise` or `copilot` scopes to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.\n> * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.", "tags": [ "copilot" ], "operationId": "copilot/copilot-content-exclusion-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-enterprise" }, "parameters": [ { @@ -47208,14 +47216,14 @@ }, "put": { "summary": "Set Copilot content exclusion rules for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets Copilot content exclusion path rules for an enterprise.\nTo configure these settings, go to the enterprise's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-enterprise).\"\n\nEnterprise owners can set Copilot content exclusion rules for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `admin:enterprise` or `copilot` scopes to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.\n> * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets Copilot content exclusion path rules for an enterprise.\nTo configure these settings, go to the enterprise's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-enterprise).\"\n\nEnterprise owners can set Copilot content exclusion rules for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `admin:enterprise` or `copilot` scopes to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.\n> * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.", "tags": [ "copilot" ], "operationId": "copilot/set-copilot-content-exclusion-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-enterprise" }, "parameters": [ { @@ -47495,7 +47503,7 @@ "operationId": "copilot/get-copilot-custom-agents-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-custom-agents#get-custom-agents-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-custom-agents#get-custom-agents-for-an-enterprise" }, "parameters": [ { @@ -47509,7 +47517,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -47518,7 +47526,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -47708,7 +47716,7 @@ "operationId": "copilot/get-copilot-custom-agents-source-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-custom-agents#get-the-source-organization-for-custom-agents-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-custom-agents#get-the-source-organization-for-custom-agents-in-an-enterprise" }, "parameters": [ { @@ -47867,7 +47875,7 @@ "operationId": "copilot/set-copilot-custom-agents-source-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-custom-agents#set-the-source-organization-for-custom-agents-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-custom-agents#set-the-source-organization-for-custom-agents-in-an-enterprise" }, "parameters": [ { @@ -48178,7 +48186,7 @@ "operationId": "copilot/delete-copilot-custom-agents-source-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-custom-agents#delete-the-custom-agents-source-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-custom-agents#delete-the-custom-agents-source-for-an-enterprise" }, "x-github": { "githubCloudOnly": true, @@ -48266,7 +48274,7 @@ "operationId": "copilot/copilot-metrics-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise" }, "parameters": [ { @@ -48298,7 +48306,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -48307,7 +48315,7 @@ }, { "name": "per_page", - "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -48922,7 +48930,7 @@ "operationId": "copilot/copilot-enterprise-one-day-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day" }, "parameters": [ { @@ -49088,7 +49096,7 @@ "operationId": "copilot/copilot-enterprise-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics" }, "parameters": [ { @@ -49248,7 +49256,7 @@ "operationId": "copilot/copilot-users-one-day-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day" }, "parameters": [ { @@ -49414,7 +49422,7 @@ "operationId": "copilot/copilot-users-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics" }, "parameters": [ { @@ -49567,14 +49575,14 @@ "/enterprises/{enterprise}/copilot/policies/coding_agent": { "put": { "summary": "Set the coding agent policy for an enterprise", - "description": "Sets the policy for Copilot coding agent usage across an enterprise.\n\nEnterprise owners can configure whether Copilot coding agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.\n\nOnly enterprise owners can set the coding agent policy for their enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "description": "Sets the policy for Copilot cloud agent usage across an enterprise.\n\nEnterprise owners can configure whether Copilot cloud agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.\n\nOnly enterprise owners can set the coding agent policy for their enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/set-enterprise-coding-agent-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#set-the-coding-agent-policy-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#set-the-coding-agent-policy-for-an-enterprise" }, "parameters": [ { @@ -49597,7 +49605,7 @@ "properties": { "policy_state": { "type": "string", - "description": "The policy state for Copilot coding agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.", + "description": "The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.", "enum": [ "enabled_for_all_orgs", "disabled_for_all_orgs", @@ -49704,14 +49712,14 @@ "/enterprises/{enterprise}/copilot/policies/coding_agent/organizations": { "post": { "summary": "Add organizations to the enterprise coding agent policy", - "description": "Enables Copilot coding agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can add organizations to the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "description": "Enables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can add organizations to the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/add-organizations-to-enterprise-coding-agent-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#add-organizations-to-the-enterprise-coding-agent-policy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#add-organizations-to-the-enterprise-coding-agent-policy" }, "parameters": [ { @@ -49725,7 +49733,7 @@ } ], "requestBody": { - "description": "The organizations to enable Copilot coding agent for", + "description": "The organizations to enable Copilot cloud agent for", "required": true, "content": { "application/json": { @@ -49734,7 +49742,7 @@ "properties": { "organizations": { "type": "array", - "description": "List of organization logins within the enterprise to enable Copilot coding agent for.", + "description": "List of organization logins within the enterprise to enable Copilot cloud agent for.", "items": { "type": "string" } @@ -49869,14 +49877,14 @@ }, "delete": { "summary": "Remove organizations from the enterprise coding agent policy", - "description": "Disables Copilot coding agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can remove organizations from the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "description": "Disables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can remove organizations from the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/remove-organizations-from-enterprise-coding-agent-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#remove-organizations-from-the-enterprise-coding-agent-policy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#remove-organizations-from-the-enterprise-coding-agent-policy" }, "parameters": [ { @@ -49890,7 +49898,7 @@ } ], "requestBody": { - "description": "The organizations to disable Copilot coding agent for", + "description": "The organizations to disable Copilot cloud agent for", "required": true, "content": { "application/json": { @@ -49899,7 +49907,7 @@ "properties": { "organizations": { "type": "array", - "description": "List of organization logins within the enterprise to disable Copilot coding agent for.", + "description": "List of organization logins within the enterprise to disable Copilot cloud agent for.", "items": { "type": "string" } @@ -50036,14 +50044,14 @@ "/enterprises/{enterprise}/dependabot/alerts": { "get": { "summary": "List Dependabot alerts for an enterprise", - "description": "Lists Dependabot alerts for repositories that are owned by the specified enterprise.\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nAlerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.", + "description": "Lists Dependabot alerts for repositories that are owned by the specified enterprise.\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nAlerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/list-alerts-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise" }, "parameters": [ { @@ -50174,7 +50182,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -50183,7 +50191,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -50192,7 +50200,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -52284,7 +52292,7 @@ "operationId": "dependabot/repository-access-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-enterprise" }, "parameters": [ { @@ -53061,7 +53069,7 @@ "operationId": "dependabot/update-repository-access-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-enterprise" }, "parameters": [ { @@ -53206,7 +53214,7 @@ "operationId": "dependabot/set-repository-access-default-level-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot-in-an-enterprise" }, "parameters": [ { @@ -53328,7 +53336,7 @@ "operationId": "secret-scanning/list-enterprise-dismissal-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-an-enterprise" }, "x-github": { "githubCloudOnly": true, @@ -53409,7 +53417,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -53418,7 +53426,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -53810,7 +53818,7 @@ "operationId": "enterprise-admin/list-enterprise-roles", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#get-all-enterprise-roles-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#get-all-enterprise-roles-for-an-enterprise" }, "parameters": [ { @@ -54129,7 +54137,7 @@ "operationId": "enterprise-admin/revoke-all-enterprise-roles-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-team" }, "parameters": [ { @@ -54229,7 +54237,7 @@ "operationId": "enterprise-admin/assign-team-to-enterprise-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-a-team" }, "parameters": [ { @@ -54336,7 +54344,7 @@ "operationId": "enterprise-admin/revoke-enterprise-role-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-an-enterprise-role-from-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#remove-an-enterprise-role-from-a-team" }, "parameters": [ { @@ -54445,7 +54453,7 @@ "operationId": "enterprise-admin/remove-all-enterprise-roles-from-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-user" }, "parameters": [ { @@ -54545,7 +54553,7 @@ "operationId": "enterprise-admin/assign-enterprise-role-to-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-an-enterprise-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-an-enterprise-user" }, "parameters": [ { @@ -54652,7 +54660,7 @@ "operationId": "enterprise-admin/remove-enterprise-user-role-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-enterprise-user-role-assignment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#remove-enterprise-user-role-assignment" }, "parameters": [ { @@ -54761,7 +54769,7 @@ "operationId": "enterprise-admin/get-enterprise-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#get-an-enterprise-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#get-an-enterprise-role" }, "parameters": [ { @@ -55047,7 +55055,7 @@ "operationId": "enterprise-admin/list-enterprise-role-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#list-teams-that-are-assigned-to-an-enterprise-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#list-teams-that-are-assigned-to-an-enterprise-role" }, "parameters": [ { @@ -55070,7 +55078,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -55079,7 +55087,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -55272,7 +55280,7 @@ "operationId": "enterprise-admin/list-enterprise-role-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#list-users-that-are-assigned-to-an-enterprise-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#list-users-that-are-assigned-to-an-enterprise-role" }, "parameters": [ { @@ -55295,7 +55303,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -55304,7 +55312,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -55746,14 +55754,14 @@ "/enterprises/{enterprise}/installation": { "get": { "summary": "Get an enterprise installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find its installation on a particular enterprise.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find its installation on a particular enterprise.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-enterprise-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-enterprise-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-enterprise-installation-for-the-authenticated-app" }, "parameters": [ { @@ -56379,7 +56387,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -56894,7 +56902,7 @@ "operationId": "enterprise-admin/get-license-sync-status", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#get-a-license-sync-status" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/licensing#get-a-license-sync-status" }, "parameters": [ { @@ -56995,7 +57003,7 @@ "operationId": "copilot/get-copilot-seat-details-for-enterprise-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-an-enterprise-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-an-enterprise-user" }, "parameters": [ { @@ -57938,7 +57946,7 @@ "operationId": "hosted-compute/list-network-configurations-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#list-hosted-compute-network-configurations-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#list-hosted-compute-network-configurations-for-an-enterprise" }, "parameters": [ { @@ -57952,7 +57960,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -57961,7 +57969,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -58120,7 +58128,7 @@ "operationId": "hosted-compute/create-network-configuration-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#create-a-hosted-compute-network-configuration-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#create-a-hosted-compute-network-configuration-for-an-enterprise" }, "parameters": [ { @@ -58309,7 +58317,7 @@ "operationId": "hosted-compute/get-network-configuration-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-configuration-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-configuration-for-an-enterprise" }, "parameters": [ { @@ -58452,7 +58460,7 @@ "operationId": "hosted-compute/update-network-configuration-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#update-a-hosted-compute-network-configuration-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#update-a-hosted-compute-network-configuration-for-an-enterprise" }, "parameters": [ { @@ -58644,7 +58652,7 @@ "operationId": "hosted-compute/delete-network-configuration-from-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#delete-a-hosted-compute-network-configuration-from-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#delete-a-hosted-compute-network-configuration-from-an-enterprise" }, "parameters": [ { @@ -58690,7 +58698,7 @@ "operationId": "hosted-compute/get-network-settings-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise" }, "parameters": [ { @@ -58806,7 +58814,7 @@ "operationId": "enterprise-admin/custom-properties-for-orgs-get-enterprise-definitions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-organization-custom-properties-schema-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#get-organization-custom-properties-schema-for-an-enterprise" }, "parameters": [ { @@ -59041,7 +59049,7 @@ "operationId": "enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definitions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-organization-custom-property-definitions-on-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#create-or-update-organization-custom-property-definitions-on-an-enterprise" }, "parameters": [ { @@ -59470,7 +59478,7 @@ "operationId": "enterprise-admin/custom-properties-for-orgs-get-enterprise-definition", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-an-organization-custom-property-definition-from-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#get-an-organization-custom-property-definition-from-an-enterprise" }, "parameters": [ { @@ -59696,7 +59704,7 @@ "operationId": "enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definition", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-an-organization-custom-property-definition-on-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#create-or-update-an-organization-custom-property-definition-on-an-enterprise" }, "parameters": [ { @@ -60052,7 +60060,7 @@ "operationId": "enterprise-admin/custom-properties-for-orgs-delete-enterprise-definition", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#remove-an-organization-custom-property-definition-from-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#remove-an-organization-custom-property-definition-from-an-enterprise" }, "parameters": [ { @@ -60179,7 +60187,7 @@ "operationId": "enterprise-admin/custom-properties-for-orgs-get-enterprise-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#list-custom-property-values-for-organizations-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#list-custom-property-values-for-organizations-in-an-enterprise" }, "parameters": [ { @@ -60193,7 +60201,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -60202,7 +60210,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -60384,7 +60392,7 @@ "operationId": "enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-custom-property-values-for-organizations-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#create-or-update-custom-property-values-for-organizations-in-an-enterprise" }, "parameters": [ { @@ -60634,7 +60642,7 @@ "operationId": "enterprise-admin/custom-properties-for-repos-get-enterprise-definitions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-custom-properties-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#get-custom-properties-for-an-enterprise" }, "parameters": [ { @@ -60865,7 +60873,7 @@ "operationId": "enterprise-admin/custom-properties-for-repos-create-or-update-enterprise-definitions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-custom-properties-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#create-or-update-custom-properties-for-an-enterprise" }, "parameters": [ { @@ -61252,7 +61260,7 @@ "operationId": "enterprise-admin/custom-properties-for-repos-promote-definition-to-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#promote-a-custom-property-to-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#promote-a-custom-property-to-an-enterprise" }, "parameters": [ { @@ -61483,7 +61491,7 @@ "operationId": "enterprise-admin/custom-properties-for-repos-get-enterprise-definition", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise" }, "parameters": [ { @@ -61703,7 +61711,7 @@ "operationId": "enterprise-admin/custom-properties-for-repos-create-or-update-enterprise-definition", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-for-an-enterprise" }, "parameters": [ { @@ -62027,7 +62035,7 @@ "operationId": "enterprise-admin/custom-properties-for-repos-delete-enterprise-definition", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise" }, "parameters": [ { @@ -62124,7 +62132,7 @@ "operationId": "repos/create-enterprise-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#create-an-enterprise-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#create-an-enterprise-repository-ruleset" }, "parameters": [ { @@ -62185,7 +62193,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -62195,7 +62203,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -63757,7 +63766,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -63767,7 +63776,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -63939,7 +63948,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -63949,7 +63958,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -65115,7 +65125,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -65125,7 +65135,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -65309,7 +65319,7 @@ "operationId": "repos/get-enterprise-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-an-enterprise-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#get-an-enterprise-repository-ruleset" }, "parameters": [ { @@ -65403,7 +65413,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -65413,7 +65423,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -66579,7 +66590,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -66589,7 +66600,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -66771,7 +66782,7 @@ "operationId": "repos/update-enterprise-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#update-an-enterprise-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#update-an-enterprise-repository-ruleset" }, "parameters": [ { @@ -66840,7 +66851,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -66850,7 +66861,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -68412,7 +68424,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -68422,7 +68434,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -68590,7 +68602,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -68600,7 +68612,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -69766,7 +69779,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -69776,7 +69789,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -69958,7 +69971,7 @@ "operationId": "repos/delete-enterprise-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#delete-an-enterprise-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#delete-an-enterprise-repository-ruleset" }, "parameters": [ { @@ -70055,7 +70068,7 @@ "operationId": "enterprise-admin/get-enterprise-ruleset-history", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-enterprise-ruleset-history" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#get-enterprise-ruleset-history" }, "parameters": [ { @@ -70069,7 +70082,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -70078,7 +70091,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -70239,7 +70252,7 @@ "operationId": "enterprise-admin/get-enterprise-ruleset-version", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-enterprise-ruleset-version" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#get-enterprise-ruleset-version" }, "parameters": [ { @@ -70427,14 +70440,14 @@ "/enterprises/{enterprise}/secret-scanning/alerts": { "get": { "summary": "List secret scanning alerts for an enterprise", - "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for repositories owned by enterprise managed users.", + "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for repositories owned by enterprise managed users.", "tags": [ "secret-scanning" ], "operationId": "secret-scanning/list-alerts-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise" }, "parameters": [ { @@ -70462,7 +70475,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -70471,7 +70484,7 @@ { "name": "exclude_secret_types", "in": "query", - "description": "A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the `secret_type` parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "description": "A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the `secret_type` parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -70557,7 +70570,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -70566,7 +70579,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -70575,7 +70588,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -70884,7 +70897,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -72916,7 +72929,7 @@ "operationId": "secret-scanning/list-enterprise-pattern-configs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-enterprise-pattern-configurations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/push-protection#list-enterprise-pattern-configurations" }, "x-github": { "githubCloudOnly": true, @@ -73213,7 +73226,7 @@ "operationId": "secret-scanning/update-enterprise-pattern-configs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-enterprise-pattern-configurations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/push-protection#update-enterprise-pattern-configurations" }, "x-github": { "githubCloudOnly": true, @@ -73579,7 +73592,7 @@ "operationId": "billing/get-github-advanced-security-billing-ghe", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise" }, "parameters": [ { @@ -73606,7 +73619,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -73615,7 +73628,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -73776,7 +73789,7 @@ "operationId": "billing/get-all-budgets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#get-all-budgets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/budgets#get-all-budgets" }, "parameters": [ { @@ -74072,7 +74085,7 @@ "operationId": "billing/create-budget", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#create-a-budget" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/budgets#create-a-budget" }, "parameters": [ { @@ -74590,7 +74603,7 @@ "operationId": "billing/get-budget", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#get-a-budget-by-id" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/budgets#get-a-budget-by-id" }, "parameters": [ { @@ -74924,7 +74937,7 @@ "operationId": "billing/update-budget", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#update-a-budget" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/budgets#update-a-budget" }, "parameters": [ { @@ -75489,7 +75502,7 @@ "operationId": "billing/delete-budget", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#delete-a-budget" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/budgets#delete-a-budget" }, "parameters": [ { @@ -75730,7 +75743,7 @@ "operationId": "billing/get-all-cost-centers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#get-all-cost-centers-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#get-all-cost-centers-for-an-enterprise" }, "parameters": [ { @@ -76018,7 +76031,7 @@ "operationId": "billing/create-cost-center", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#create-a-new-cost-center" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#create-a-new-cost-center" }, "parameters": [ { @@ -76191,7 +76204,7 @@ "operationId": "billing/get-cost-center", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#get-a-cost-center-by-id" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#get-a-cost-center-by-id" }, "parameters": [ { @@ -76214,7 +76227,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -76223,7 +76236,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -76474,7 +76487,7 @@ "operationId": "billing/update-cost-center", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#update-a-cost-center-name" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#update-a-cost-center-name" }, "parameters": [ { @@ -76814,7 +76827,7 @@ "operationId": "billing/delete-cost-center", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#delete-a-cost-center" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#delete-a-cost-center" }, "parameters": [ { @@ -77070,7 +77083,7 @@ "operationId": "billing/add-resource-to-cost-center", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#add-resources-to-a-cost-center" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#add-resources-to-a-cost-center" }, "parameters": [ { @@ -77382,7 +77395,7 @@ "operationId": "billing/remove-resource-from-cost-center", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#remove-resources-from-a-cost-center" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#remove-resources-from-a-cost-center" }, "parameters": [ { @@ -77630,7 +77643,7 @@ "operationId": "billing/get-github-billing-premium-request-usage-report-ghe", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/usage#get-billing-premium-request-usage-report-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/usage#get-billing-premium-request-usage-report-for-an-enterprise" }, "parameters": [ { @@ -78066,7 +78079,7 @@ "operationId": "billing/list-usage-report-exports", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/usage-reports#list-usage-report-exports" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/usage-reports#list-usage-report-exports" }, "parameters": [ { @@ -78364,7 +78377,7 @@ "operationId": "billing/create-usage-report-export", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/usage-reports#create-a-usage-report-export" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/usage-reports#create-a-usage-report-export" }, "parameters": [ { @@ -78753,7 +78766,7 @@ "operationId": "billing/get-usage-report-export", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/usage-reports#get-a-usage-report-export" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/usage-reports#get-a-usage-report-export" }, "parameters": [ { @@ -79022,14 +79035,14 @@ "/enterprises/{enterprise}/settings/billing/usage": { "get": { "summary": "Get billing usage report for an enterprise", - "description": "Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center.\n\n**Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest//billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform).\"", + "description": "Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center.\n\n**Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest/billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform).\"", "tags": [ "billing" ], "operationId": "billing/get-github-billing-usage-report-ghe", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/usage#get-billing-usage-report-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/usage#get-billing-usage-report-for-an-enterprise" }, "parameters": [ { @@ -79336,7 +79349,7 @@ "operationId": "billing/get-github-billing-usage-summary-report-ghe", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/usage#get-billing-usage-summary-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/usage#get-billing-usage-summary-for-an-enterprise" }, "parameters": [ { @@ -79733,14 +79746,14 @@ "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { "get": { "summary": "Get Copilot metrics for an enterprise team", - "description": "> [!NOTE]\n> This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest//admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nUse this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nUse this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/copilot-metrics-for-enterprise-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team" }, "parameters": [ { @@ -79781,7 +79794,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -79790,7 +79803,7 @@ }, { "name": "per_page", - "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -80405,7 +80418,7 @@ "operationId": "enterprise-teams/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#list-enterprise-teams" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-teams#list-enterprise-teams" }, "parameters": [ { @@ -80419,7 +80432,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -80428,7 +80441,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -80601,7 +80614,7 @@ "operationId": "enterprise-teams/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#create-an-enterprise-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-teams#create-an-enterprise-team" }, "parameters": [ { @@ -80643,7 +80656,7 @@ }, "organization_selection_type": { "type": "string", - "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint.\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint.\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", "enum": [ "disabled", "selected", @@ -80656,7 +80669,7 @@ "string", "null" ], - "description": "The ID of the IdP group to assign team membership with. You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/enterprise-cloud@latest//rest/scim#list-provisioned-scim-groups-for-an-enterprise)." + "description": "The ID of the IdP group to assign team membership with. You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/enterprise-cloud@latest/rest/scim#list-provisioned-scim-groups-for-an-enterprise)." } }, "required": [ @@ -80803,7 +80816,7 @@ "operationId": "enterprise-team-memberships/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team" }, "parameters": [ { @@ -80826,7 +80839,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -80835,7 +80848,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -81075,7 +81088,7 @@ "operationId": "enterprise-team-memberships/bulk-add", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-add-team-members" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members" }, "parameters": [ { @@ -81354,7 +81367,7 @@ "operationId": "enterprise-team-memberships/bulk-remove", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members" }, "parameters": [ { @@ -81633,7 +81646,7 @@ "operationId": "enterprise-team-memberships/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership" }, "parameters": [ { @@ -81881,7 +81894,7 @@ "operationId": "enterprise-team-memberships/add", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#add-team-member" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#add-team-member" }, "parameters": [ { @@ -82129,7 +82142,7 @@ "operationId": "enterprise-team-memberships/remove", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#remove-team-membership" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#remove-team-membership" }, "parameters": [ { @@ -82209,7 +82222,7 @@ "operationId": "enterprise-team-organizations/get-assignments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments" }, "parameters": [ { @@ -82232,7 +82245,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -82241,7 +82254,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -82396,7 +82409,7 @@ "operationId": "enterprise-team-organizations/bulk-add", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments" }, "parameters": [ { @@ -82599,7 +82612,7 @@ "operationId": "enterprise-team-organizations/bulk-remove", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments" }, "parameters": [ { @@ -82676,7 +82689,7 @@ "operationId": "enterprise-team-organizations/get-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment" }, "parameters": [ { @@ -82852,7 +82865,7 @@ "operationId": "enterprise-team-organizations/add", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment" }, "parameters": [ { @@ -83025,7 +83038,7 @@ "operationId": "enterprise-team-organizations/delete", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment" }, "parameters": [ { @@ -83079,7 +83092,7 @@ "operationId": "enterprise-teams/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#get-an-enterprise-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team" }, "parameters": [ { @@ -83261,7 +83274,7 @@ "operationId": "enterprise-teams/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#update-an-enterprise-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team" }, "parameters": [ { @@ -83315,7 +83328,7 @@ }, "organization_selection_type": { "type": "string", - "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments).\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments).\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", "enum": [ "disabled", "selected", @@ -83504,7 +83517,7 @@ "operationId": "enterprise-teams/delete", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team" }, "parameters": [ { @@ -83568,14 +83581,14 @@ "/enterprises/{enterprise}/{security_product}/{enablement}": { "post": { "summary": "Enable or disable a security feature", - "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nEnables or disables the specified security feature for all repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nEnables or disables the specified security feature for all repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], "operationId": "secret-scanning/post-security-product-enablement-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/code-security-and-analysis#enable-or-disable-a-security-feature" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/code-security-and-analysis#enable-or-disable-a-security-feature" }, "parameters": [ { @@ -83673,12 +83686,12 @@ "operationId": "activity/list-public-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-events" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -83687,7 +83700,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -96716,14 +96729,14 @@ "/feeds": { "get": { "summary": "Get feeds", - "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub Enterprise Cloud global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n> [!NOTE]\n> Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.", + "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub Enterprise Cloud global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n> [!NOTE]\n> Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.", "tags": [ "activity" ], "operationId": "activity/get-feeds", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/feeds#get-feeds" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/feeds#get-feeds" }, "parameters": [], "responses": { @@ -97065,7 +97078,7 @@ "operationId": "gists/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-gists-for-the-authenticated-user" }, "parameters": [ { @@ -97080,7 +97093,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -97089,7 +97102,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -97679,7 +97692,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#create-a-gist" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#create-a-gist" }, "parameters": [], "requestBody": { @@ -99229,14 +99242,14 @@ "/gists/public": { "get": { "summary": "List public gists", - "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.", + "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.", "tags": [ "gists" ], "operationId": "gists/list-public", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-public-gists" }, "parameters": [ { @@ -99251,7 +99264,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -99260,7 +99273,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -99927,7 +99940,7 @@ "operationId": "gists/list-starred", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-starred-gists" }, "parameters": [ { @@ -99942,7 +99955,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -99951,7 +99964,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -100562,14 +100575,14 @@ "/gists/{gist_id}": { "get": { "summary": "Get a gist", - "description": "Gets a specified gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", + "description": "Gets a specified gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", "tags": [ "gists" ], "operationId": "gists/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#get-a-gist" }, "parameters": [ { @@ -101970,14 +101983,14 @@ }, "patch": { "summary": "Update a gist", - "description": "Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.\n\nAt least one of `description` or `files` is required.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", + "description": "Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.\n\nAt least one of `description` or `files` is required.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", "tags": [ "gists" ], "operationId": "gists/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#update-a-gist" }, "parameters": [ { @@ -103664,7 +103677,7 @@ "operationId": "gists/delete", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#delete-a-gist" }, "parameters": [ { @@ -103748,14 +103761,14 @@ "/gists/{gist_id}/comments": { "get": { "summary": "List gist comments", - "description": "Lists the comments on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", + "description": "Lists the comments on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", "tags": [ "gists" ], "operationId": "gists/list-comments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/comments#list-gist-comments" }, "parameters": [ { @@ -103769,7 +103782,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -103778,7 +103791,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -104156,14 +104169,14 @@ }, "post": { "summary": "Create a gist comment", - "description": "Creates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", + "description": "Creates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", "tags": [ "gists" ], "operationId": "gists/create-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/comments#create-a-gist-comment" }, "parameters": [ { @@ -104574,14 +104587,14 @@ "/gists/{gist_id}/comments/{comment_id}": { "get": { "summary": "Get a gist comment", - "description": "Gets a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", + "description": "Gets a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", "tags": [ "gists" ], "operationId": "gists/get-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/comments#get-a-gist-comment" }, "parameters": [ { @@ -104970,14 +104983,14 @@ }, "patch": { "summary": "Update a gist comment", - "description": "Updates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", + "description": "Updates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", "tags": [ "gists" ], "operationId": "gists/update-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/comments#update-a-gist-comment" }, "parameters": [ { @@ -105366,7 +105379,7 @@ "operationId": "gists/delete-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/comments#delete-a-gist-comment" }, "parameters": [ { @@ -105467,7 +105480,7 @@ "operationId": "gists/list-commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-gist-commits" }, "parameters": [ { @@ -105481,7 +105494,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -105490,7 +105503,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -105850,7 +105863,7 @@ "operationId": "gists/list-forks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-gist-forks" }, "parameters": [ { @@ -105864,7 +105877,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -105873,7 +105886,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -107242,7 +107255,7 @@ "operationId": "gists/fork", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#fork-a-gist" }, "parameters": [ { @@ -107935,7 +107948,7 @@ "operationId": "gists/check-is-starred", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#check-if-a-gist-is-starred" }, "parameters": [ { @@ -108003,14 +108016,14 @@ }, "put": { "summary": "Star a gist", - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "gists" ], "operationId": "gists/star", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#star-a-gist" }, "parameters": [ { @@ -108099,7 +108112,7 @@ "operationId": "gists/unstar", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#unstar-a-gist" }, "parameters": [ { @@ -108183,14 +108196,14 @@ "/gists/{gist_id}/{sha}": { "get": { "summary": "Get a gist revision", - "description": "Gets a specified gist revision.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", + "description": "Gets a specified gist revision.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", "tags": [ "gists" ], "operationId": "gists/get-revision", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#get-a-gist-revision" }, "parameters": [ { @@ -109664,14 +109677,14 @@ "/gitignore/templates": { "get": { "summary": "Get all gitignore templates", - "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-for-the-authenticated-user).", + "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-for-the-authenticated-user).", "operationId": "gitignore/get-all-templates", "tags": [ "gitignore" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gitignore/gitignore#get-all-gitignore-templates" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gitignore/gitignore#get-all-gitignore-templates" }, "parameters": [], "responses": { @@ -109716,14 +109729,14 @@ "/gitignore/templates/{name}": { "get": { "summary": "Get a gitignore template", - "description": "Get the content of a gitignore template.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.", + "description": "Get the content of a gitignore template.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.", "operationId": "gitignore/get-template", "tags": [ "gitignore" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gitignore/gitignore#get-a-gitignore-template" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gitignore/gitignore#get-a-gitignore-template" }, "parameters": [ { @@ -109796,12 +109809,12 @@ "operationId": "apps/list-repos-accessible-to-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#list-repositories-accessible-to-the-app-installation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#list-repositories-accessible-to-the-app-installation" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -109810,7 +109823,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -111021,14 +111034,14 @@ "/installation/token": { "delete": { "summary": "Revoke an installation access token", - "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-an-installation-access-token-for-an-app)\" endpoint.", + "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#create-an-installation-access-token-for-an-app)\" endpoint.", "tags": [ "apps" ], "operationId": "apps/revoke-installation-access-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#revoke-an-installation-access-token" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#revoke-an-installation-access-token" }, "parameters": [], "responses": { @@ -111047,14 +111060,14 @@ "/issues": { "get": { "summary": "List issues assigned to the authenticated user", - "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-issues-assigned-to-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-issues-assigned-to-the-authenticated-user" }, "parameters": [ { @@ -111172,7 +111185,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -111181,7 +111194,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -115451,14 +115464,14 @@ "/licenses": { "get": { "summary": "Get all commonly used licenses", - "description": "Lists the most commonly used licenses on GitHub. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", + "description": "Lists the most commonly used licenses on GitHub. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", "tags": [ "licenses" ], "operationId": "licenses/get-all-commonly-used", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-all-commonly-used-licenses" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/licenses/licenses#get-all-commonly-used-licenses" }, "parameters": [ { @@ -115471,7 +115484,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -115480,7 +115493,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -115624,14 +115637,14 @@ "/licenses/{license}": { "get": { "summary": "Get a license", - "description": "Gets information about a specific license. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", + "description": "Gets information about a specific license. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", "tags": [ "licenses" ], "operationId": "licenses/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-a-license" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/licenses/licenses#get-a-license" }, "parameters": [ { @@ -115875,7 +115888,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/markdown/markdown#render-a-markdown-document" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/markdown/markdown#render-a-markdown-document" }, "parameters": [], "requestBody": { @@ -115980,7 +115993,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/markdown/markdown#render-a-markdown-document-in-raw-mode" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/markdown/markdown#render-a-markdown-document-in-raw-mode" }, "parameters": [], "requestBody": { @@ -116053,14 +116066,14 @@ "/marketplace_listing/accounts/{account_id}": { "get": { "summary": "Get a subscription plan for an account", - "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-subscription-plan-for-account", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#get-a-subscription-plan-for-an-account" }, "parameters": [ { @@ -116521,19 +116534,19 @@ "/marketplace_listing/plans": { "get": { "summary": "List plans", - "description": "Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/list-plans", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-plans" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-plans" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -116542,7 +116555,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -116768,14 +116781,14 @@ "/marketplace_listing/plans/{plan_id}/accounts": { "get": { "summary": "List accounts for a plan", - "description": "Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/list-accounts-for-plan", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-accounts-for-a-plan" }, "parameters": [ { @@ -116816,7 +116829,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -116825,7 +116838,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -117368,14 +117381,14 @@ "/marketplace_listing/stubbed/accounts/{account_id}": { "get": { "summary": "Get a subscription plan for an account (stubbed)", - "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-subscription-plan-for-account-stubbed", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed" }, "parameters": [ { @@ -117813,19 +117826,19 @@ "/marketplace_listing/stubbed/plans": { "get": { "summary": "List plans (stubbed)", - "description": "Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/list-plans-stubbed", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-plans-stubbed" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-plans-stubbed" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -117834,7 +117847,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -118034,14 +118047,14 @@ "/marketplace_listing/stubbed/plans/{plan_id}/accounts": { "get": { "summary": "List accounts for a plan (stubbed)", - "description": "Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/list-accounts-for-plan-stubbed", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-accounts-for-a-plan-stubbed" }, "parameters": [ { @@ -118082,7 +118095,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -118091,7 +118104,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -118533,14 +118546,14 @@ "/meta": { "get": { "summary": "Get GitHub Enterprise Cloud meta information", - "description": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"[About GitHub's IP addresses](https://docs.github.com/enterprise-cloud@latest//articles/about-github-s-ip-addresses/).\"\n\nThe API's response also includes a list of GitHub's domain names.\n\nThe values shown in the documentation's response are example values. You must always query the API directly to get the latest values.\n\n> [!NOTE]\n> This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.", + "description": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"[About GitHub's IP addresses](https://docs.github.com/enterprise-cloud@latest/articles/about-github-s-ip-addresses/).\"\n\nThe API's response also includes a list of GitHub's domain names.\n\nThe values shown in the documentation's response are example values. You must always query the API directly to get the latest values.\n\n> [!NOTE]\n> This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.", "tags": [ "meta" ], "operationId": "meta/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#get-apiname-meta-information" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/meta/meta#get-apiname-meta-information" }, "parameters": [], "responses": { @@ -118893,7 +118906,7 @@ "operationId": "activity/list-public-events-for-repo-network", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-events-for-a-network-of-repositories" }, "parameters": [ { @@ -118916,7 +118929,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -118925,7 +118938,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -131992,7 +132005,7 @@ "operationId": "activity/list-notifications-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user" }, "parameters": [ { @@ -132037,7 +132050,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -132046,7 +132059,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 50). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 50). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -133314,14 +133327,14 @@ }, "put": { "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], "operationId": "activity/mark-notifications-as-read", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-notifications-as-read" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-notifications-as-read" }, "parameters": [], "requestBody": { @@ -133453,12 +133466,12 @@ "operationId": "activity/get-thread", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#get-a-thread" }, "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user)).", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -134645,12 +134658,12 @@ "operationId": "activity/mark-thread-as-read", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-a-thread-as-read" }, "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user)).", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -134708,12 +134721,12 @@ "operationId": "activity/mark-thread-as-done", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-a-thread-as-done" }, "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user)).", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -134737,19 +134750,19 @@ "/notifications/threads/{thread_id}/subscription": { "get": { "summary": "Get a thread subscription for the authenticated user", - "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", + "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", "tags": [ "activity" ], "operationId": "activity/get-thread-subscription-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user" }, "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user)).", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -134902,19 +134915,19 @@ }, "put": { "summary": "Set a thread subscription", - "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription) endpoint.", + "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#delete-a-thread-subscription) endpoint.", "tags": [ "activity" ], "operationId": "activity/set-thread-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#set-a-thread-subscription" }, "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user)).", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -135091,19 +135104,19 @@ }, "delete": { "summary": "Delete a thread subscription", - "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`.", + "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`.", "tags": [ "activity" ], "operationId": "activity/delete-thread-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#delete-a-thread-subscription" }, "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user)).", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -135217,7 +135230,7 @@ }, "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#get-octocat" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/meta/meta#get-octocat" }, "x-github": { "githubCloudOnly": false, @@ -135230,14 +135243,14 @@ "/organizations": { "get": { "summary": "List organizations", - "description": "Lists all organizations, in the order that they were created.\n\n> [!NOTE]\n> Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", + "description": "Lists all organizations, in the order that they were created.\n\n> [!NOTE]\n> Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", "tags": [ "orgs" ], "operationId": "orgs/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-organizations" }, "parameters": [ { @@ -135251,7 +135264,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -135412,14 +135425,14 @@ "/organizations/{organization_id}/custom_roles": { "get": { "summary": "Closing down - List custom repository roles in an organization", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed in the future. Use the \"[List custom repository roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)\" endpoint instead.\n\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed in the future. Use the \"[List custom repository roles](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)\" endpoint instead.\n\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-custom-roles", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-custom-repository-roles-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---list-custom-repository-roles-in-an-organization" }, "parameters": [ { @@ -135730,7 +135743,7 @@ "operationId": "actions/get-actions-cache-retention-limit-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization" }, "parameters": [ { @@ -135841,7 +135854,7 @@ "operationId": "actions/set-actions-cache-retention-limit-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization" }, "parameters": [ { @@ -136025,7 +136038,7 @@ "operationId": "actions/get-actions-cache-storage-limit-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization" }, "parameters": [ { @@ -136136,7 +136149,7 @@ "operationId": "actions/set-actions-cache-storage-limit-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization" }, "parameters": [ { @@ -136320,7 +136333,7 @@ "operationId": "orgs/custom-properties-for-orgs-get-organization-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization" }, "parameters": [ { @@ -136465,7 +136478,7 @@ "operationId": "orgs/custom-properties-for-orgs-create-or-update-organization-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization" }, "parameters": [ { @@ -136694,14 +136707,14 @@ "/orgs/{org}": { "get": { "summary": "Get an organization", - "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/enterprise-cloud@latest//articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the `Organization plan` permission.", + "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/enterprise-cloud@latest/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the `Organization plan` permission.", "tags": [ "orgs" ], "operationId": "orgs/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#get-an-organization" }, "parameters": [ { @@ -137114,7 +137127,7 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ], @@ -137122,7 +137135,7 @@ }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ], @@ -137130,7 +137143,7 @@ }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ], @@ -137138,7 +137151,7 @@ }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ], @@ -137146,7 +137159,7 @@ }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ], @@ -137154,7 +137167,7 @@ }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ], @@ -137179,7 +137192,7 @@ }, "secret_scanning_validity_checks_enabled": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", "examples": [ false ], @@ -137356,14 +137369,14 @@ }, "patch": { "summary": "Update an organization", - "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Cloud will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\n> [!WARNING]\n> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Cloud will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\n> [!WARNING]\n> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#update-an-organization" }, "parameters": [ { @@ -137437,15 +137450,15 @@ }, "members_can_create_internal_repositories": { "type": "boolean", - "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." }, "members_can_create_private_repositories": { "type": "boolean", - "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." }, "members_can_create_public_repositories": { "type": "boolean", - "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." }, "members_allowed_repository_creation_type": { "type": "string", @@ -137489,32 +137502,32 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { @@ -137527,7 +137540,7 @@ }, "secret_scanning_validity_checks_enabled": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", "deprecated": true }, "deploy_keys_enabled_for_repositories": { @@ -137955,7 +137968,7 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ], @@ -137963,7 +137976,7 @@ }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ], @@ -137971,7 +137984,7 @@ }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ], @@ -137979,7 +137992,7 @@ }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ], @@ -137987,7 +138000,7 @@ }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ], @@ -137995,7 +138008,7 @@ }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ], @@ -138020,7 +138033,7 @@ }, "secret_scanning_validity_checks_enabled": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", "examples": [ false ], @@ -138299,14 +138312,14 @@ }, "delete": { "summary": "Delete an organization", - "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/enterprise-cloud@latest//site-policy/github-terms/github-terms-of-service", + "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/enterprise-cloud@latest/site-policy/github-terms/github-terms-of-service", "operationId": "orgs/delete", "tags": [ "orgs" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#delete-an-organization" }, "parameters": [ { @@ -138406,7 +138419,7 @@ "operationId": "actions/get-actions-cache-usage-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-usage-for-an-organization" }, "parameters": [ { @@ -138479,7 +138492,7 @@ "operationId": "actions/get-actions-cache-usage-by-repo-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" }, "parameters": [ { @@ -138493,7 +138506,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -138502,7 +138515,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -138612,7 +138625,7 @@ "operationId": "actions/list-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization" }, "parameters": [ { @@ -138626,7 +138639,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -138635,7 +138648,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -138966,7 +138979,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -139339,7 +139352,7 @@ "operationId": "actions/list-custom-images-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-custom-images-for-an-organization" }, "parameters": [ { @@ -139488,7 +139501,7 @@ "operationId": "actions/get-custom-image-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners" }, "parameters": [ { @@ -139622,7 +139635,7 @@ "operationId": "actions/delete-custom-image-from-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization" }, "parameters": [ { @@ -139667,7 +139680,7 @@ "operationId": "actions/list-custom-image-versions-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization" }, "parameters": [ { @@ -139801,7 +139814,7 @@ "operationId": "actions/get-custom-image-version-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners" }, "parameters": [ { @@ -139917,7 +139930,7 @@ "operationId": "actions/delete-custom-image-version-from-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization" }, "parameters": [ { @@ -139972,7 +139985,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -140089,7 +140102,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -140206,7 +140219,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization" }, "parameters": [ { @@ -140289,7 +140302,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization" }, "parameters": [ { @@ -140395,7 +140408,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -140464,7 +140477,7 @@ "operationId": "actions/get-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -140768,7 +140781,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -141130,7 +141143,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -141428,7 +141441,7 @@ "operationId": "oidc/list-oidc-custom-property-inclusions-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-organization" }, "parameters": [ { @@ -141558,7 +141571,7 @@ "operationId": "oidc/create-oidc-custom-property-inclusion-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-organization" }, "parameters": [ { @@ -141690,7 +141703,7 @@ "operationId": "oidc/delete-oidc-custom-property-inclusion-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-organization" }, "parameters": [ { @@ -141766,7 +141779,7 @@ "operationId": "oidc/get-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -141795,6 +141808,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } }, "required": [ @@ -141830,7 +141847,7 @@ "operationId": "oidc/update-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -141858,6 +141875,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.", + "type": "boolean" } } }, @@ -141965,7 +141986,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-github-actions-permissions-for-an-organization" }, "parameters": [ { @@ -142051,7 +142072,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-github-actions-permissions-for-an-organization" }, "parameters": [ { @@ -142133,7 +142154,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" }, "parameters": [ { @@ -142248,7 +142269,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" }, "parameters": [ { @@ -142462,7 +142483,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" }, "parameters": [ { @@ -142549,7 +142570,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" }, "parameters": [ { @@ -142717,7 +142738,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -142843,7 +142864,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -143046,7 +143067,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -143060,7 +143081,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -143069,7 +143090,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -144217,7 +144238,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -144286,7 +144307,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -144329,7 +144350,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -144374,7 +144395,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -144444,7 +144465,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -144519,7 +144540,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -144638,7 +144659,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -144857,7 +144878,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -144871,7 +144892,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -144880,7 +144901,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -146075,7 +146096,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -146270,7 +146291,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -146465,7 +146486,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -146655,14 +146676,14 @@ "/orgs/{org}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for an organization", - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-github-actions-default-workflow-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-default-workflow-permissions-for-an-organization" }, "parameters": [ { @@ -146723,14 +146744,14 @@ }, "put": { "summary": "Set default workflow permissions for an organization", - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/set-github-actions-default-workflow-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-default-workflow-permissions-for-an-organization" }, "parameters": [ { @@ -146802,7 +146823,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization" }, "parameters": [ { @@ -146816,7 +146837,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -146825,7 +146846,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -147002,7 +147023,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { @@ -147219,7 +147240,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { @@ -147357,7 +147378,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { @@ -147559,7 +147580,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" }, "parameters": [ { @@ -147604,7 +147625,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { @@ -147627,7 +147648,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -147636,7 +147657,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -147969,7 +147990,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -147992,7 +148013,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -148001,7 +148022,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -149242,7 +149263,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -149320,7 +149341,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -149372,7 +149393,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -149426,7 +149447,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { @@ -149449,7 +149470,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -149458,7 +149479,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -149663,7 +149684,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { @@ -149741,7 +149762,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" }, "parameters": [ { @@ -149793,7 +149814,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" }, "parameters": [ { @@ -149847,7 +149868,7 @@ "operationId": "actions/list-self-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" }, "parameters": [ { @@ -149869,7 +149890,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -149878,7 +149899,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -150085,7 +150106,7 @@ "operationId": "actions/list-runner-applications-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization" }, "parameters": [ { @@ -150196,7 +150217,7 @@ "operationId": "actions/generate-runner-jitconfig-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization" }, "parameters": [ { @@ -150506,7 +150527,7 @@ "operationId": "actions/create-registration-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization" }, "parameters": [ { @@ -151578,7 +151599,7 @@ "operationId": "actions/create-remove-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization" }, "parameters": [ { @@ -152650,7 +152671,7 @@ "operationId": "actions/get-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -152816,7 +152837,7 @@ "operationId": "actions/delete-self-hosted-runner-from-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization" }, "parameters": [ { @@ -152891,7 +152912,7 @@ "operationId": "actions/list-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -153034,7 +153055,7 @@ "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -153241,7 +153262,7 @@ "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -153448,7 +153469,7 @@ "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -153588,7 +153609,7 @@ "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -153772,7 +153793,7 @@ "operationId": "actions/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-organization-secrets" }, "parameters": [ { @@ -153786,7 +153807,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -153795,7 +153816,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -153925,7 +153946,7 @@ "operationId": "actions/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-organization-public-key" }, "parameters": [ { @@ -154022,7 +154043,7 @@ "operationId": "actions/get-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-organization-secret" }, "parameters": [ { @@ -154117,14 +154138,14 @@ }, "put": { "summary": "Create or update an organization secret", - "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/create-or-update-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-organization-secret" }, "parameters": [ { @@ -154155,7 +154176,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-organization-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -154173,7 +154194,7 @@ }, "selected_repository_ids": { "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "type": "integer" } @@ -154241,7 +154262,7 @@ "operationId": "actions/delete-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-an-organization-secret" }, "parameters": [ { @@ -154286,7 +154307,7 @@ "operationId": "actions/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -154309,7 +154330,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -154318,7 +154339,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -155380,14 +155401,14 @@ }, "put": { "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], "operationId": "actions/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -155418,7 +155439,7 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "type": "integer" } @@ -155456,14 +155477,14 @@ "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { "put": { "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -155510,14 +155531,14 @@ }, "delete": { "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], "operationId": "actions/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { @@ -155573,7 +155594,7 @@ "operationId": "actions/list-org-variables", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-organization-variables" }, "parameters": [ { @@ -155587,7 +155608,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -155596,7 +155617,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -155743,7 +155764,7 @@ "operationId": "actions/create-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-an-organization-variable" }, "parameters": [ { @@ -155849,7 +155870,7 @@ "operationId": "actions/get-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-an-organization-variable" }, "parameters": [ { @@ -155968,7 +155989,7 @@ "operationId": "actions/update-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-an-organization-variable" }, "parameters": [ { @@ -156060,7 +156081,7 @@ "operationId": "actions/delete-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-an-organization-variable" }, "parameters": [ { @@ -156105,7 +156126,7 @@ "operationId": "actions/list-selected-repos-for-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-selected-repositories-for-an-organization-variable" }, "parameters": [ { @@ -156128,7 +156149,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -156137,7 +156158,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -157209,7 +157230,7 @@ "operationId": "actions/set-selected-repos-for-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#set-selected-repositories-for-an-organization-variable" }, "parameters": [ { @@ -157288,7 +157309,7 @@ "operationId": "actions/add-selected-repo-to-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#add-selected-repository-to-an-organization-variable" }, "parameters": [ { @@ -157342,7 +157363,7 @@ "operationId": "actions/remove-selected-repo-from-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#remove-selected-repository-from-an-organization-variable" }, "parameters": [ { @@ -157398,7 +157419,7 @@ "operationId": "announcement-banners/get-announcement-banner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/organizations#get-announcement-banner-for-organization" }, "parameters": [ { @@ -157426,7 +157447,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", "examples": [ "Very **important** announcement about _something_." ] @@ -157490,7 +157511,7 @@ "operationId": "announcement-banners/set-announcement-banner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#set-announcement-banner-for-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/organizations#set-announcement-banner-for-organization" }, "requestBody": { "required": true, @@ -157506,7 +157527,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", "examples": [ "Very **important** announcement about _something_." ] @@ -157577,7 +157598,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", "examples": [ "Very **important** announcement about _something_." ] @@ -157641,7 +157662,7 @@ "operationId": "announcement-banners/remove-announcement-banner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/organizations#remove-announcement-banner-from-organization" }, "parameters": [ { @@ -157677,7 +157698,7 @@ "operationId": "orgs/create-artifact-deployment-record", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#create-an-artifact-deployment-record" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/artifact-metadata#create-an-artifact-deployment-record" }, "parameters": [ { @@ -157994,7 +158015,7 @@ "operationId": "orgs/set-cluster-deployment-records", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#set-cluster-deployment-records" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/artifact-metadata#set-cluster-deployment-records" }, "parameters": [ { @@ -158356,7 +158377,7 @@ "operationId": "orgs/create-artifact-storage-record", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#create-artifact-metadata-storage-record" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record" }, "parameters": [ { @@ -158643,7 +158664,7 @@ "operationId": "orgs/list-artifact-deployment-records", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#list-artifact-deployment-records" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/artifact-metadata#list-artifact-deployment-records" }, "parameters": [ { @@ -158792,7 +158813,7 @@ "operationId": "orgs/list-artifact-storage-records", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#list-artifact-storage-records" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/artifact-metadata#list-artifact-storage-records" }, "parameters": [ { @@ -158904,19 +158925,19 @@ "/orgs/{org}/attestations/bulk-list": { "post": { "summary": "List attestations by bulk subject digests", - "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", "tags": [ "orgs" ], "operationId": "orgs/list-attestations-bulk", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations-by-bulk-subject-digests" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#list-attestations-by-bulk-subject-digests" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -158925,7 +158946,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -158934,7 +158955,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -159226,7 +159247,7 @@ "operationId": "orgs/delete-attestations-bulk", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-in-bulk" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#delete-attestations-in-bulk" }, "parameters": [ { @@ -159353,7 +159374,7 @@ "operationId": "orgs/delete-attestations-by-subject-digest", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-subject-digest" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#delete-attestations-by-subject-digest" }, "parameters": [ { @@ -159428,12 +159449,12 @@ "operationId": "orgs/list-attestation-repositories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestation-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#list-attestation-repositories" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -159442,7 +159463,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -159451,7 +159472,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -159532,7 +159553,7 @@ "operationId": "orgs/delete-attestations-by-id", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-id" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#delete-attestations-by-id" }, "parameters": [ { @@ -159625,19 +159646,19 @@ "/orgs/{org}/attestations/{subject_digest}": { "get": { "summary": "List attestations", - "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", "tags": [ "orgs" ], "operationId": "orgs/list-attestations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#list-attestations" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -159646,7 +159667,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -159655,7 +159676,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -159885,14 +159906,14 @@ "/orgs/{org}/audit-log": { "get": { "summary": "Get the audit log for an organization", - "description": "Gets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nBy default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).\"\n\nUse pagination to retrieve fewer or more than 30 events. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\"\n\nThis endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api)\" and \"[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", + "description": "Gets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nBy default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).\"\n\nUse pagination to retrieve fewer or more than 30 events. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api).\"\n\nThis endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api)\" and \"[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-integrators).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", "operationId": "orgs/get-audit-log", "tags": [ "orgs" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-the-audit-log-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#get-the-audit-log-for-an-organization" }, "parameters": [ { @@ -159906,7 +159927,7 @@ }, { "name": "phrase", - "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).", + "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).", "in": "query", "required": false, "schema": { @@ -159929,7 +159950,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor.", "in": "query", "required": false, "schema": { @@ -159938,7 +159959,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor.", "in": "query", "required": false, "schema": { @@ -159960,7 +159981,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -160197,7 +160218,7 @@ "operationId": "orgs/list-blocked-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking#list-users-blocked-by-an-organization" }, "parameters": [ { @@ -160211,7 +160232,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -160220,7 +160241,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -160452,7 +160473,7 @@ "operationId": "orgs/check-blocked-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization" }, "parameters": [ { @@ -160521,7 +160542,7 @@ "operationId": "orgs/block-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking#block-a-user-from-an-organization" }, "parameters": [ { @@ -160639,7 +160660,7 @@ "operationId": "orgs/unblock-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking#unblock-a-user-from-an-organization" }, "parameters": [ { @@ -160684,7 +160705,7 @@ "operationId": "orgs/list-push-bypass-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/bypass-requests#list-push-rule-bypass-requests-within-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/bypass-requests#list-push-rule-bypass-requests-within-an-organization" }, "x-github": { "githubCloudOnly": true, @@ -160766,7 +160787,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -160775,7 +160796,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -161160,7 +161181,7 @@ "operationId": "secret-scanning/list-org-bypass-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-org" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-org" }, "x-github": { "githubCloudOnly": true, @@ -161242,7 +161263,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -161251,7 +161272,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -161625,7 +161646,7 @@ "operationId": "campaigns/list-org-campaigns", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#list-campaigns-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/campaigns/campaigns#list-campaigns-for-an-organization" }, "parameters": [ { @@ -161639,7 +161660,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -161648,7 +161669,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -162383,7 +162404,7 @@ "operationId": "campaigns/create-campaign", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#create-a-campaign-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/campaigns/campaigns#create-a-campaign-for-an-organization" }, "parameters": [ { @@ -163225,7 +163246,7 @@ "operationId": "campaigns/get-campaign-summary", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#get-a-campaign-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/campaigns/campaigns#get-a-campaign-for-an-organization" }, "parameters": [ { @@ -163916,7 +163937,7 @@ "operationId": "campaigns/update-campaign", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#update-a-campaign" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/campaigns/campaigns#update-a-campaign" }, "parameters": [ { @@ -164704,7 +164725,7 @@ "operationId": "campaigns/delete-campaign", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#delete-a-campaign-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/campaigns/campaigns#delete-a-campaign-for-an-organization" }, "parameters": [ { @@ -164789,14 +164810,14 @@ "/orgs/{org}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for an organization", - "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "tags": [ "code-scanning" ], "operationId": "code-scanning/list-alerts-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization" }, "parameters": [ { @@ -164833,7 +164854,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -164842,7 +164863,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -164851,7 +164872,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -164860,7 +164881,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -166647,7 +166668,7 @@ "operationId": "code-security/get-configurations-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-code-security-configurations-for-an-organization" }, "parameters": [ { @@ -166676,7 +166697,7 @@ { "name": "per_page", "in": "query", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "required": false, "schema": { "type": "integer", @@ -166685,7 +166706,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -166694,7 +166715,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -167154,7 +167175,7 @@ "operationId": "code-security/create-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#create-a-code-security-configuration" }, "parameters": [ { @@ -167880,7 +167901,7 @@ "operationId": "code-security/get-default-configurations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-default-code-security-configurations" }, "parameters": [ { @@ -168379,7 +168400,7 @@ "operationId": "code-security/detach-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#detach-configurations-from-repositories" }, "parameters": [ { @@ -168598,7 +168619,7 @@ "operationId": "code-security/get-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-a-code-security-configuration" }, "parameters": [ { @@ -169059,7 +169080,7 @@ "operationId": "code-security/update-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#update-a-code-security-configuration" }, "parameters": [ { @@ -169763,7 +169784,7 @@ "operationId": "code-security/delete-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#delete-a-code-security-configuration" }, "parameters": [ { @@ -169954,7 +169975,7 @@ "operationId": "code-security/attach-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#attach-a-configuration-to-repositories" }, "parameters": [ { @@ -170058,7 +170079,7 @@ "operationId": "code-security/set-configuration-as-default", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization" }, "parameters": [ { @@ -170568,7 +170589,7 @@ "operationId": "code-security/get-repositories-for-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration" }, "parameters": [ { @@ -170591,7 +170612,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -170601,7 +170622,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -170610,7 +170631,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -171362,12 +171383,12 @@ "operationId": "codespaces/list-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#list-codespaces-for-the-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#list-codespaces-for-the-organization" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -171376,7 +171397,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -173645,7 +173666,7 @@ "operationId": "codespaces/set-codespaces-access", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#manage-access-control-for-organization-codespaces" }, "parameters": [ { @@ -173852,14 +173873,14 @@ "/orgs/{org}/codespaces/access/selected_users": { "post": { "summary": "Add users to Codespaces access for an organization", - "description": "Codespaces for the specified users will be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Codespaces for the specified users will be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "codespaces" ], "operationId": "codespaces/set-codespaces-access-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization" }, "parameters": [ { @@ -174053,14 +174074,14 @@ }, "delete": { "summary": "Remove users from Codespaces access for an organization", - "description": "Codespaces for the specified users will no longer be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Codespaces for the specified users will no longer be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "codespaces" ], "operationId": "codespaces/delete-codespaces-access-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization" }, "deprecated": true, "parameters": [ @@ -174263,7 +174284,7 @@ "operationId": "codespaces/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#list-organization-secrets" }, "parameters": [ { @@ -174277,7 +174298,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -174286,7 +174307,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -174412,7 +174433,7 @@ "operationId": "codespaces/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#get-an-organization-public-key" }, "parameters": [ { @@ -174509,7 +174530,7 @@ "operationId": "codespaces/get-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#get-an-organization-secret" }, "parameters": [ { @@ -174614,14 +174635,14 @@ }, "put": { "summary": "Create or update an organization secret", - "description": "Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "codespaces" ], "operationId": "codespaces/create-or-update-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#create-or-update-an-organization-secret" }, "parameters": [ { @@ -174652,7 +174673,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint.", + "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -174670,7 +174691,7 @@ }, "selected_repository_ids": { "type": "array", - "description": "An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "type": "integer" } @@ -174837,7 +174858,7 @@ "operationId": "codespaces/delete-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#delete-an-organization-secret" }, "parameters": [ { @@ -174908,7 +174929,7 @@ "operationId": "codespaces/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -174931,7 +174952,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -174940,7 +174961,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -176028,14 +176049,14 @@ }, "put": { "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Replaces all repositories for an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "codespaces" ], "operationId": "codespaces/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -176066,7 +176087,7 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "type": "integer" } @@ -176133,14 +176154,14 @@ "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": { "put": { "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "codespaces" ], "operationId": "codespaces/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -176288,14 +176309,14 @@ }, "delete": { "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Removes a repository from an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "codespaces" ], "operationId": "codespaces/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { @@ -176442,17 +176463,17 @@ } } }, - "/orgs/{org}/copilot/billing": { + "/orgs/{org}/copilot-spaces": { "get": { - "summary": "Get Copilot seat information and settings for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "summary": "List organization Copilot Spaces", + "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/get-copilot-organization-details", + "operationId": "copilot-spaces/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/copilot-spaces#list-organization-copilot-spaces" }, "parameters": [ { @@ -176463,288 +176484,32 @@ "schema": { "type": "string" } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "title": "Copilot Organization Details", - "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.", - "type": "object", - "properties": { - "seat_breakdown": { - "title": "Copilot Seat Breakdown", - "description": "The breakdown of Copilot Business seats for the organization.", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "The total number of seats being billed for the organization as of the current billing cycle." - }, - "added_this_cycle": { - "type": "integer", - "description": "Seats added during the current billing cycle." - }, - "pending_cancellation": { - "type": "integer", - "description": "The number of seats that are pending cancellation at the end of the current billing cycle." - }, - "pending_invitation": { - "type": "integer", - "description": "The number of users who have been invited to receive a Copilot seat through this organization." - }, - "active_this_cycle": { - "type": "integer", - "description": "The number of seats that have used Copilot during the current billing cycle." - }, - "inactive_this_cycle": { - "type": "integer", - "description": "The number of seats that have not used Copilot during the current billing cycle." - } - } - }, - "public_code_suggestions": { - "type": "string", - "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).", - "enum": [ - "allow", - "block", - "unconfigured" - ] - }, - "ide_chat": { - "type": "string", - "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] - }, - "platform_chat": { - "type": "string", - "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] - }, - "cli": { - "type": "string", - "description": "The organization policy for allowing or disallowing Copilot CLI.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] - }, - "seat_management_setting": { - "type": "string", - "description": "The mode of assigning new seats.", - "enum": [ - "assign_all", - "assign_selected", - "disabled", - "unconfigured" - ] - }, - "plan_type": { - "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", - "enum": [ - "business", - "enterprise" - ] - } - }, - "required": [ - "seat_breakdown", - "public_code_suggestions", - "seat_management_setting" - ], - "additionalProperties": true - }, - "examples": { - "default": { - "value": { - "seat_breakdown": { - "total": 12, - "added_this_cycle": 9, - "pending_invitation": 0, - "pending_cancellation": 0, - "active_this_cycle": 12, - "inactive_this_cycle": 11 - }, - "seat_management_setting": "assign_selected", - "ide_chat": "enabled", - "platform_chat": "enabled", - "cli": "enabled", - "public_code_suggestions": "block", - "plan_type": "business" - } - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "There is a problem with your account's associated payment method." - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" - } - } - }, - "/orgs/{org}/copilot/billing/seats": { - "get": { - "summary": "List all Copilot seat assignments for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data).\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/list-copilot-seats", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" - }, - "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 } }, { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", "in": "query", "schema": { - "type": "integer", - "default": 1 + "type": "string" } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", "in": "query", "schema": { - "type": "integer", - "default": 50 + "type": "string" } } ], @@ -176755,23 +176520,76 @@ "application/json": { "schema": { "type": "object", + "required": [ + "spaces" + ], "properties": { - "total_seats": { - "type": "integer", - "description": "Total number of Copilot seats for the organization currently being billed." - }, - "seats": { + "spaces": { "type": "array", + "description": "The list of Copilot Spaces on this page of results.", "items": { - "title": "Copilot Business Seat Detail", - "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", "type": "object", "properties": { - "assignee": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { "anyOf": [ - { - "type": "null" - }, { "title": "Simple User", "description": "A GitHub user.", @@ -176939,13 +176757,6 @@ "type", "url" ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" }, { "title": "Organization Simple", @@ -177046,412 +176857,312 @@ "description" ] } - ] + ], + "description": "The user or organization that owns this space." }, - "assigning_team": { - "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", - "oneOf": [ - { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - { - "title": "Enterprise Team", - "description": "Group of enterprise owners and/or members", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "sync_to_organizations": { - "type": "string", - "description": "Retired: this field will not be returned with GHEC enterprise teams.", - "examples": [ - "disabled | all" - ] - }, - "organization_selection_type": { - "type": "string", - "examples": [ - "disabled | selected | all" - ] - }, - "group_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "62ab9291-fae2-468e-974b-7e45096d5021" - ] - }, - "group_name": { - "type": [ - "string", - "null" - ], - "description": "Retired: this field will not be returned with GHEC enterprise teams.", - "examples": [ - "Justice League" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/dc/teams/justice-league" - ] - }, - "members_url": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "url", - "members_url", - "name", - "html_url", - "slug", - "created_at", - "updated_at", - "group_id" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } - ], - "type": [ - "null", - "object" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "pending_cancellation_date": { - "type": [ - "string", - "null" - ], - "format": "date", - "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." - }, - "last_activity_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." - }, - "last_activity_editor": { - "type": [ - "string", - "null" - ], - "description": "Last editor that was used by the user for a GitHub Copilot completion." - }, - "last_authenticated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format." - }, "created_at": { "type": "string", "format": "date-time", - "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] }, "updated_at": { "type": "string", "format": "date-time", - "deprecated": true, - "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] }, - "plan_type": { + "html_url": { "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", - "enum": [ - "business", - "enterprise", - "unknown" + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } } }, "required": [ - "created_at" + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" ], "additionalProperties": false } @@ -177460,21 +177171,98 @@ }, "examples": { "default": { + "summary": "Example response for listing organization copilot spaces", "value": { - "total_seats": 2, - "seats": [ + "spaces": [ { - "created_at": "2021-08-03T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": null, - "last_activity_at": "2021-10-14T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "last_authenticated_at": "2021-10-14T00:53:32-06:00", - "plan_type": "business", - "assignee": { - "login": "octocat", + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "owner": { + "login": "octo-org", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3" + }, + { + "id": 85, + "number": 4, + "name": "Development Resources", + "description": "Shared development documentation and resources", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", @@ -177491,49 +177279,10 @@ "type": "User", "site_admin": false }, - "assigning_team": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - }, - { - "created_at": "2021-09-23T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": "2021-11-01", - "last_activity_at": "2021-10-13T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "last_authenticated_at": "2021-10-14T00:53:32-06:00", - "assignee": { - "login": "octokitten", - "id": 1, - "node_id": "MDQ76VNlcjE=", - "avatar_url": "https://github.com/images/error/octokitten_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octokitten", - "html_url": "https://github.com/octokitten", - "followers_url": "https://api.github.com/users/octokitten/followers", - "following_url": "https://api.github.com/users/octokitten/following{/other_user}", - "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", - "organizations_url": "https://api.github.com/users/octokitten/orgs", - "repos_url": "https://api.github.com/users/octokitten/repos", - "events_url": "https://api.github.com/users/octokitten/events{/privacy}", - "received_events_url": "https://api.github.com/users/octokitten/received_events", - "type": "User", - "site_admin": false - } + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/4", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/4" } ] } @@ -177550,58 +177299,6 @@ } } }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "403": { "description": "Forbidden", "content": { @@ -177656,24 +177353,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } - } - }, - "/orgs/{org}/copilot/billing/selected_teams": { + }, "post": { - "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "summary": "Create an organization Copilot Space", + "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/add-copilot-seats-for-teams", + "operationId": "copilot-spaces/create-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/copilot-spaces#create-an-organization-copilot-space" }, "parameters": [ { @@ -177687,292 +177381,855 @@ } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "selected_teams": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "Team Planning Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Organization space for team planning and coordination" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help the team with planning and coordination tasks" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions for organization members.\n- `no_access`: No default access (default)\n- `reader`: Organization members can read the space\n- `writer`: Organization members can read and edit the space\n- `admin`: Organization members have full admin access to the space", + "default": "no_access" + }, + "resources_attributes": { "type": "array", - "description": "List of team names within the organization to which to grant access to GitHub Copilot.", + "description": "Resources to attach to the space.", "items": { - "type": "string" - }, - "minItems": 1 + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } } }, "required": [ - "selected_teams" + "name" ] }, "examples": { "default": { "value": { - "selected_teams": [ - "engteam1", - "engteam2", - "engteam3" + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/planning.md" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology and holds daily standups" + } + } ] } } } } - }, - "required": true + } }, "responses": { "201": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats created for members of the specified team(s).", - "properties": { - "seats_created": { - "type": "integer" - } - }, - "required": [ - "seats_created" - ] - }, - "examples": { - "default": { - "value": { - "seats_created": 5 - } - } - } - } - } - }, - "500": { - "description": "Internal Error", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] }, - "url": { - "type": "string" + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] }, - "documentation_url": { - "type": "string" + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] }, - "url": { - "type": "string" + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] }, - "documentation_url": { - "type": "string" + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." }, - "url": { - "type": "string" + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] }, - "documentation_url": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] }, - "url": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" - } - }, - "delete": { - "summary": "Remove teams from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/cancel-copilot-seat-assignment-for-teams", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_teams": { - "type": "array", - "description": "The names of teams from which to revoke access to GitHub Copilot.", - "items": { - "type": "string" + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] }, - "minItems": 1 - } - }, - "required": [ - "selected_teams" - ] - }, - "examples": { - "default": { - "value": { - "selected_teams": [ - "engteam1", - "engteam2", - "engteam3" - ] - } - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", - "properties": { - "seats_cancelled": { - "type": "integer" + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } } }, "required": [ - "seats_cancelled" - ] + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false }, "examples": { "default": { + "summary": "Example response for an organization copilot space", "value": { - "seats_cancelled": 5 - } - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] } } } } } }, - "401": { - "description": "Requires authentication", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -177997,8 +178254,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -178023,14 +178280,18 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -178038,40 +178299,81 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } } }, - "/orgs/{org}/copilot/billing/selected_users": { - "post": { - "summary": "Add users to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "/orgs/{org}/copilot-spaces/{space_number}": { + "get": { + "summary": "Get an organization Copilot Space", + "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/add-copilot-seats-for-users", + "operationId": "copilot-spaces/get-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/copilot-spaces#get-an-organization-copilot-space" }, "parameters": [ { @@ -178082,313 +178384,738 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_usernames": { - "type": "array", - "description": "The usernames of the organization members to be granted access to GitHub Copilot.", - "items": { - "type": "string" - }, - "minItems": 1 - } - }, - "required": [ - "selected_usernames" - ] - }, - "examples": { - "default": { - "value": { - "selected_usernames": [ - "cooluser1", - "hacker2", - "octocat" - ] - } - } - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats created for the specified user(s).", - "properties": { - "seats_created": { - "type": "integer" - } - }, - "required": [ - "seats_created" - ] - }, - "examples": { - "default": { - "value": { - "seats_created": 5 - } - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" - } - }, - "delete": { - "summary": "Remove users from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/cancel-copilot-seat-assignment-for-users", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization" - }, - "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_usernames": { - "type": "array", - "description": "The usernames of the organization members for which to revoke access to GitHub Copilot.", - "items": { - "type": "string" - }, - "minItems": 1 - } - }, - "required": [ - "selected_usernames" - ] - }, - "examples": { - "default": { - "value": { - "selected_usernames": [ - "cooluser1", - "hacker2", - "octocat" - ] - } - } - } - } - }, - "required": true - }, "responses": { "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats set to \"pending cancellation\" for the specified users.", - "properties": { - "seats_cancelled": { - "type": "integer" - } - }, - "required": [ - "seats_cancelled" - ] - }, - "examples": { - "default": { - "value": { - "seats_cancelled": 5 - } - } - } - } - } - }, - "500": { - "description": "Internal Error", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] }, - "url": { - "type": "string" + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] }, - "documentation_url": { - "type": "string" + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] }, - "url": { - "type": "string" + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] }, - "status": { - "type": "string" + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + }, + "examples": { + "default": { + "summary": "Example response for an organization copilot space", + "value": { + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] } } } @@ -178446,30 +179173,24 @@ } } } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team." } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } - } - }, - "/orgs/{org}/copilot/coding-agent/permissions": { - "get": { - "summary": "Get Copilot coding agent permissions for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about which repositories in an organization have been enabled\nor disabled for the Copilot coding agent.\n\nOrganization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + }, + "put": { + "summary": "Set an organization Copilot Space", + "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/get-copilot-coding-agent-permissions-organization", + "operationId": "copilot-spaces/update-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/copilot-spaces#set-an-organization-copilot-space" }, "parameters": [ { @@ -178480,86 +179201,868 @@ "schema": { "type": "string" } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "Updated Team Planning Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Updated organization space for team planning and coordination" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Updated instructions to help the team with planning and coordination tasks" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions for organization members. Changing this field requires admin permissions.\n- `no_access`: No default access (default)\n- `reader`: Organization members can read the space\n- `writer`: Organization members can read and edit the space\n- `admin`: Organization members have full admin access to the space" + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "Updated Team Planning Space", + "description": "Updated organization space for team planning and coordination", + "general_instructions": "Updated instructions to help the team with planning and coordination tasks", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 123456, + "file_path": "docs/updated-planning.md" + } + }, + { + "id": 789, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Team Guidelines", + "text": "Our updated team follows agile methodology and holds daily standups" + } + } + ] + } + } + } + } + } + }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", "type": "object", "properties": { - "enabled_repositories": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", "enum": [ - "all", - "selected", - "none" + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" ] }, - "selected_repositories_url": { + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { "type": "string", - "description": "The URL for the selected repositories endpoint. Only present when `enabled_repositories` is `selected`." + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } } }, "required": [ - "enabled_repositories" - ] + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false }, "examples": { - "all_enabled": { - "summary": "All repositories enabled", - "value": { - "enabled_repositories": "all" - } - }, - "selected_enabled": { - "summary": "Selected repositories enabled", - "value": { - "enabled_repositories": "selected", - "selected_repositories_url": "https://api.github.com/orgs/my-org/copilot/coding-agent/permissions/repositories" - } - }, - "none_enabled": { - "summary": "No repositories enabled", + "default": { + "summary": "Example response for an organization copilot space", "value": { - "enabled_repositories": "none" - } - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "id": 84, + "number": 3, + "name": "Team Planning Space", + "description": "Organization space for team planning and coordination", + "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices", + "owner": { + "login": "octo-org", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "gravatar_id": "", + "name": "octo-org", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "octo-org", + "html_url": "https://github.com/octo-org", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + }, + "creator": { + "login": "defunkt", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/defunkt_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/defunkt", + "html_url": "https://github.com/defunkt", + "followers_url": "https://api.github.com/users/defunkt/followers", + "following_url": "https://api.github.com/users/defunkt/following{/other_user}", + "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}", + "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions", + "organizations_url": "https://api.github.com/users/defunkt/orgs", + "repos_url": "https://api.github.com/users/defunkt/repos", + "events_url": "https://api.github.com/users/defunkt/events{/privacy}", + "received_events_url": "https://api.github.com/users/defunkt/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octo-org/3", + "api_url": "https://api.github.com/organizations/1/copilot-spaces/3", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 123, + "resource_type": "github_file", + "metadata": { + "repository_id": 456, + "file_path": "docs/planning.md" + } + }, + { + "id": 124, + "resource_type": "free_text", + "metadata": { + "name": "Team Guidelines", + "text": "Our team follows agile methodology" + } + } + ] } } } } } }, - "401": { - "description": "Requires authentication", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -178584,8 +180087,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -178610,14 +180113,18 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -178625,11 +180132,56 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -178638,22 +180190,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } }, - "put": { - "summary": "Set Copilot coding agent permissions for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets the policy for which repositories in an organization can use Copilot coding agent.\n\nOrganization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "delete": { + "summary": "Delete an organization Copilot Space", + "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/set-copilot-coding-agent-permissions-organization", + "operationId": "copilot-spaces/delete-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/copilot-spaces#delete-an-organization-copilot-space" }, "parameters": [ { @@ -178664,120 +180215,20 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "enabled_repositories": { - "type": "string", - "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", - "enum": [ - "all", - "selected", - "none" - ] - } - }, - "required": [ - "enabled_repositories" - ] - }, - "examples": { - "default": { - "value": { - "enabled_repositories": "selected" - } - } - } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } - }, + ], "responses": { "204": { - "description": "No Content" - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } + "description": "The Copilot Space has been successfully deleted." }, "404": { "description": "Resource not found", @@ -178882,24 +180333,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } } }, - "/orgs/{org}/copilot/coding-agent/permissions/repositories": { + "/orgs/{org}/copilot-spaces/{space_number}/collaborators": { "get": { - "summary": "List repositories enabled for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists the selected repositories that are enabled for Copilot coding agent in an organization.\n\nOrganization owners can use this endpoint when the coding agent repository policy\nis set to `selected` to see which repositories have been enabled.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "List collaborators for an organization Copilot Space", + "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/list-copilot-coding-agent-selected-repositories-for-organization", + "operationId": "copilot-spaces/list-collaborators-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/collaborators#list-collaborators-for-an-organization-copilot-space" }, "parameters": [ { @@ -178912,21 +180362,12 @@ } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], @@ -178937,1207 +180378,375 @@ "application/json": { "schema": { "type": "object", + "required": [ + "collaborators" + ], "properties": { - "total_count": { - "type": "integer" - }, - "repositories": { + "collaborators": { "type": "array", + "description": "The list of collaborators for this Copilot Space.", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." }, - "login": { + "role": { "type": "string", - "examples": [ - "octocat" - ] + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" }, "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "type": "integer" }, "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "type": "string" }, - "avatar_url": { + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "enum": [ + "Team" ] }, - "gravatar_id": { + "description": { "type": [ "string", "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "privacy": { + "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "notification_setting": { + "type": "string" }, - "repos_url": { + "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "format": "uri" }, - "events_url": { + "html_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri" }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "members_url": { + "type": "string" }, - "type": { + "repositories_url": { "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" + "format": "uri" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "organization_id": { + "type": "integer" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" + "parent": { + "type": [ + "null" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", + "actor_type", + "role", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "name", + "slug", + "type" ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_validity_checks": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_bypass": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - }, - "mode": { - "type": "string", - "description": "The bypass mode for the reviewer", - "enum": [ - "ALWAYS", - "EXEMPT" - ], - "default": "ALWAYS" - } - } - } - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" ] } } - }, - "required": [ - "total_count", - "repositories" - ] + } }, "examples": { "default": { "value": { - "total_count": 1, - "repositories": [ + "collaborators": [ { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "octo-org", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "organization": null, - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "template_repository": null, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "delete_branch_on_merge": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "description": "A great organization" + } } ] } @@ -180146,58 +180755,6 @@ } } }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "403": { "description": "Forbidden", "content": { @@ -180249,51 +180806,24 @@ } } } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "collaborators" } }, - "put": { - "summary": "Set selected repositories for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReplaces the list of selected repositories that are enabled for Copilot coding\nagent in an organization. This method can only be called when the coding agent\nrepository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "post": { + "summary": "Add a collaborator to an organization Copilot Space", + "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/set-copilot-coding-agent-selected-repositories-for-organization", + "operationId": "copilot-spaces/add-collaborator-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/collaborators#add-a-collaborator-to-an-organization-copilot-space" }, "parameters": [ { @@ -180304,6 +180834,15 @@ "schema": { "type": "string" } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -180312,27 +180851,48 @@ "application/json": { "schema": { "type": "object", + "required": [ + "actor_type", + "actor_identifier", + "role" + ], "properties": { - "selected_repository_ids": { - "description": "List of repository IDs to enable for Copilot coding agent.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - } + "actor_type": { + "type": "string", + "enum": [ + "User", + "Team" + ], + "description": "The type of actor (user or team)." + }, + "actor_identifier": { + "type": "string", + "description": "The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role to grant to the collaborator." } - }, - "required": [ - "selected_repository_ids" - ] + } }, "examples": { - "default": { + "user": { "value": { - "selected_repository_ids": [ - 32, - 42 - ] + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" + } + }, + "team": { + "value": { + "actor_type": "Team", + "actor_identifier": "developers", + "role": "reader" } } } @@ -180340,55 +180900,355 @@ } }, "responses": { - "204": { - "description": "No Content" - }, - "500": { - "description": "Internal Error", + "201": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] }, - "status": { - "type": "string" + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + ] + }, + "examples": { + "user": { + "value": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "team": { + "value": { + "actor_type": "Team", + "role": "reader", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 } } } @@ -180447,32 +181307,6 @@ } } }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { @@ -180550,24 +181384,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "collaborators" } } }, - "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}": { + "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { "put": { - "summary": "Enable a repository for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nAdds a repository to the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Set a collaborator role for an organization Copilot Space", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/enable-copilot-coding-agent-for-repository-in-organization", + "operationId": "copilot-spaces/update-collaborator-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-an-organization-copilot-space" }, "parameters": [ { @@ -180580,71 +181413,428 @@ } }, { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { "type": "integer" } + }, + { + "name": "actor_type", + "description": "The type of actor (user or team).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], - "responses": { - "204": { - "description": "No Content" - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "role" + ], + "properties": { + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The new role to grant to the collaborator. Use `no_access` to remove the collaborator." + } + } + }, + "examples": { + "default": { + "value": { + "role": "admin" } } } } - }, - "401": { - "description": "Requires authentication", + } + }, + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] }, - "status": { - "type": "string" + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + }, + "examples": { + "user": { + "value": { + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "team": { + "value": { + "actor_type": "Team", + "role": "admin", + "id": 67890, + "node_id": "MDQ6VGVhbTY3ODkw", + "url": "https://api.github.com/teams/67890", + "html_url": "https://github.com/orgs/octo-org/teams/developers", + "name": "Developers", + "slug": "developers", + "type": "Team", + "description": "Team of developers", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/67890/members{/member}", + "repositories_url": "https://api.github.com/teams/67890/repos", + "parent": null, + "organization_id": 1 } } } } } }, + "204": { + "description": "Response when `role` is `no_access` and the collaborator was removed." + }, "403": { "description": "Forbidden", "content": { @@ -180697,32 +181887,6 @@ } } }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { @@ -180800,22 +181964,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "collaborators" } }, "delete": { - "summary": "Disable a repository for Copilot coding agent in an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemoves a repository from the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint.", + "summary": "Remove a collaborator from an organization Copilot Space", + "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/disable-copilot-coding-agent-for-repository-in-organization", + "operationId": "copilot-spaces/remove-collaborator-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/collaborators#remove-a-collaborator-from-an-organization-copilot-space" }, "parameters": [ { @@ -180828,21 +181991,43 @@ } }, { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { "type": "integer" } + }, + { + "name": "actor_type", + "description": "The type of actor (user or team).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], "responses": { "204": { - "description": "No Content" + "description": "Response" }, - "500": { - "description": "Internal Error", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -180867,8 +182052,8 @@ } } }, - "401": { - "description": "Requires authentication", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -180892,35 +182077,151 @@ } } } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + } + }, + "/orgs/{org}/copilot-spaces/{space_number}/resources": { + "get": { + "summary": "List resources for an organization Copilot Space", + "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-resources-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/resources#list-resources-for-an-organization-copilot-space" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "403": { - "description": "Forbidden", + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", + "required": [ + "resources" + ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "resources": [ + { + "id": 1, + "resource_type": "repository", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42 + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + { + "id": 2, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + ] } } } } } }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -180945,8 +182246,8 @@ } } }, - "409": { - "description": "Conflict", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -180973,187 +182274,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/orgs/{org}/copilot/content_exclusion": { - "get": { - "summary": "Get Copilot content exclusion rules for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot content exclusion path rules.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can view details about Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `copilot` or `read:org` scopes to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.\n> * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.", + }, + "post": { + "summary": "Create a resource for an organization Copilot Space", + "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/copilot-content-exclusion-for-organization", + "operationId": "copilot-spaces/create-resource-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "title": "Copilot Organization Content Exclusion Details", - "description": "List all Copilot Content Exclusion rules for an organization.", - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string", - "description": "The path to the file that will be excluded." - } - } - }, - "examples": { - "default": { - "value": { - "octo-repo": [ - "/src/some-dir/kernel.rs" - ] - } - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-content-exclusion-management" - } - }, - "put": { - "summary": "Set Copilot content exclusion rules for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets Copilot content exclusion path rules for an organization.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can set Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.\n> * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.", - "tags": [ - "copilot" - ], - "operationId": "copilot/set-copilot-content-exclusion-for-organization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/resources#create-a-resource-for-an-organization-copilot-space" }, "parameters": [ { @@ -181164,64 +182299,72 @@ "schema": { "type": "string" } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { - "description": "The content exclusion rules to set", "required": true, "content": { "application/json": { "schema": { "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string", - "description": "The path to the file that will be excluded." - }, - { - "type": "object", - "properties": { - "ifAnyMatch": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "ifAnyMatch" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ifNoneMatch": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "ifNoneMatch" - ], - "additionalProperties": false - } - ] + "required": [ + "resource_type", + "metadata" + ], + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ], + "description": "The type of resource to create." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata.", + "additionalProperties": true } } }, "examples": { - "default": { - "summary": "Example of content exclusion paths", + "free_text": { "value": { - "octo-repo": [ - "/src/some-dir/kernel.rs" - ] + "resource_type": "free_text", + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + } + } + }, + "repository": { + "value": { + "resource_type": "repository", + "metadata": { + "repository_id": 42 + } + } + }, + "github_file": { + "value": { + "resource_type": "github_file", + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + } } } } @@ -181229,74 +182372,151 @@ } }, "responses": { - "200": { - "description": "Success", + "201": { + "description": "Resource created", "content": { "application/json": { "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." } - } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] }, "examples": { "default": { "value": { - "message": "Content exclusion rules updated successfully." + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" } } } } } }, - "500": { - "description": "Internal Error", + "200": { + "description": "Duplicate github_file resource already exists", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "id": { + "type": "integer", + "description": "The unique identifier of the resource." }, - "url": { - "type": "string" + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." }, - "documentation_url": { - "type": "string" + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true }, - "url": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." }, - "status": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "github_file", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" } } } @@ -181355,39 +182575,13 @@ } } }, - "413": { - "description": "Payload Too Large", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Validation Error", + "description": "Validation Error", "type": "object", "required": [ "message", @@ -181403,664 +182597,53 @@ "errors": { "type": "array", "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": null, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-content-exclusion-management" - } - } - }, - "/orgs/{org}/copilot/metrics": { - "get": { - "summary": "Get Copilot metrics for an organization", - "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/copilot-metrics-for-organization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "since", - "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "until", - "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 100 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Copilot Usage Metrics", - "description": "Copilot usage metrics for a given day.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "total_engaged_users": { - "type": "integer", - "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "copilot_ide_code_completions": { - "type": [ - "object", - "null" + "type": "object", + "required": [ + "code" ], - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "additionalProperties": true, "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + "resource": { + "type": "string" }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." - } - } - } + "field": { + "type": "string" }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot code completion metrics for active editors.", - "additionalProperties": true, - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages, for the given editor.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions, for the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_suggestions": { - "type": "integer", - "description": "The number of Copilot code suggestions generated for the given editor, for the given language." - }, - "total_code_acceptances": { - "type": "integer", - "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." - }, - "total_code_lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." - } - } - } - } - } - } - } - } - } - } - } - }, - "copilot_ide_chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in the IDE.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat in the IDE." + "message": { + "type": "string" }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot Chat metrics, for active editors.", - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the specified editor." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the given editor and model." - }, - "total_chats": { - "type": "integer", - "description": "The total number of chats initiated by users in the given editor and model." - }, - "total_chat_insertion_events": { - "type": "integer", - "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." - }, - "total_chat_copy_events": { - "type": "integer", - "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." - } - } - } - } - } - } - } - } - }, - "copilot_dotcom_chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in GitHub.com", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once." + "code": { + "type": "string" }, - "models": { - "type": "array", - "description": "List of model metrics for a custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model (if applicable)." - }, - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." - }, - "total_chats": { - "type": "integer", - "description": "Total number of chats initiated by users on github.com." - } - } - } - } - } - }, - "copilot_dotcom_pull_requests": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot for pull requests.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + "index": { + "type": "integer" }, - "repositories": { - "type": "array", - "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Repository name" - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_pr_summaries_created": { - "type": "integer", - "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." - } - } - } + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" } } - } + ] } } } - }, - "required": [ - "date" - ], - "additionalProperties": true - } - }, - "examples": { - "default": { - "value": [ - { - "date": "2024-06-24", - "total_active_users": 24, - "total_engaged_users": 20, - "copilot_ide_code_completions": { - "total_engaged_users": 20, - "languages": [ - { - "name": "python", - "total_engaged_users": 10 - }, - { - "name": "ruby", - "total_engaged_users": 10 - } - ], - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 13, - "languages": [ - { - "name": "python", - "total_engaged_users": 6, - "total_code_suggestions": 249, - "total_code_acceptances": 123, - "total_code_lines_suggested": 225, - "total_code_lines_accepted": 135 - }, - { - "name": "ruby", - "total_engaged_users": 7, - "total_code_suggestions": 496, - "total_code_acceptances": 253, - "total_code_lines_suggested": 520, - "total_code_lines_accepted": 270 - } - ] - } - ] - }, - { - "name": "neovim", - "total_engaged_users": 7, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "languages": [ - { - "name": "typescript", - "total_engaged_users": 3, - "total_code_suggestions": 112, - "total_code_acceptances": 56, - "total_code_lines_suggested": 143, - "total_code_lines_accepted": 61 - }, - { - "name": "go", - "total_engaged_users": 4, - "total_code_suggestions": 132, - "total_code_acceptances": 67, - "total_code_lines_suggested": 154, - "total_code_lines_accepted": 72 - } - ] - } - ] - } - ] - }, - "copilot_ide_chat": { - "total_engaged_users": 13, - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 12, - "total_chats": 45, - "total_chat_insertion_events": 12, - "total_chat_copy_events": 16 - }, - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_engaged_users": 1, - "total_chats": 10, - "total_chat_insertion_events": 11, - "total_chat_copy_events": 3 - } - ] - } - ] - }, - "copilot_dotcom_chat": { - "total_engaged_users": 14, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 14, - "total_chats": 38 - } - ] - }, - "copilot_dotcom_pull_requests": { - "total_engaged_users": 12, - "repositories": [ - { - "name": "demo/repo1", - "total_engaged_users": 8, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_pr_summaries_created": 6, - "total_engaged_users": 8 - } - ] - }, - { - "name": "demo/repo2", - "total_engaged_users": 4, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_pr_summaries_created": 10, - "total_engaged_users": 4 - } - ] - } - ] - } - } - ] - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Copilot Usage Metrics API setting is disabled at the organization or enterprise level.", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" } } } @@ -182069,24 +182652,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-metrics" + "category": "copilot-spaces", + "subcategory": "resources" } } }, - "/orgs/{org}/copilot/metrics/reports/organization-1-day": { + "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": { "get": { - "summary": "Get Copilot organization usage metrics for a specific day", - "description": "Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "summary": "Get a resource for an organization Copilot Space", + "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/copilot-organization-one-day-usage-metrics", + "operationId": "copilot-spaces/get-resource-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/resources#get-a-resource-for-an-organization-copilot-space" }, "parameters": [ { @@ -182099,16 +182681,21 @@ } }, { - "name": "day", - "description": "The day to request data for, in `YYYY-MM-DD` format.", - "in": "query", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", "required": true, "schema": { - "type": "string", - "format": "date", - "examples": [ - "2025-10-13" - ] + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } ], @@ -182118,66 +182705,70 @@ "content": { "application/json": { "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", "type": "object", - "title": "Copilot Metrics 1 Day Report", - "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", "properties": { - "download_links": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + "id": { + "type": "integer", + "description": "The unique identifier of the resource." }, - "report_day": { + "resource_type": { "type": "string", - "format": "date", - "description": "The day of the report in `YYYY-MM-DD` format." + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." } }, "required": [ - "download_links", - "report_day" + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" ] }, "examples": { "default": { "value": { - "download_links": [ - "https://example.com/copilot-usage-report-1.json", - "https://example.com/copilot-usage-report-2.json" - ], - "report_day": "2025-07-01" - } - } - } - } - } - }, - "204": { - "description": "A header with no content is returned." - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" } } } @@ -182238,24 +182829,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage-metrics" + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest": { - "get": { - "summary": "Get Copilot organization usage metrics", - "description": "Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + }, + "put": { + "summary": "Set a resource for an organization Copilot Space", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/copilot-organization-usage-metrics", + "operationId": "copilot-spaces/update-resource-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/resources#set-a-resource-for-an-organization-copilot-space" }, "parameters": [ { @@ -182266,60 +182854,131 @@ "schema": { "type": "string" } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "Updated resource-specific metadata.", + "additionalProperties": true + } + } + }, + "examples": { + "default": { + "value": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + } + } + } + } + } + }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", "type": "object", - "title": "Copilot Metrics 28 Day Report", - "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", "properties": { - "download_links": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." + "id": { + "type": "integer", + "description": "The unique identifier of the resource." }, - "report_start_day": { + "resource_type": { "type": "string", - "format": "date", - "description": "The start date of the report period in `YYYY-MM-DD` format." + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] }, - "report_end_day": { + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { "type": "string", - "format": "date", - "description": "The end date of the report period in `YYYY-MM-DD` format." + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." } }, "required": [ - "download_links", - "report_start_day", - "report_end_day" + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" ] }, "examples": { "default": { "value": { - "download_links": [ - "https://example.com/copilot-usage-report-1.json", - "https://example.com/copilot-usage-report-2.json" - ], - "report_start_day": "2025-07-01", - "report_end_day": "2025-07-28" + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" } } } } } }, - "500": { - "description": "Internal Error", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -182344,8 +183003,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -182370,14 +183029,18 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -182385,11 +183048,56 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -182398,24 +183106,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage-metrics" + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/orgs/{org}/copilot/metrics/reports/users-1-day": { - "get": { - "summary": "Get Copilot organization users usage metrics for a specific day", - "description": "Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + }, + "delete": { + "summary": "Delete a resource from an organization Copilot Space", + "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "copilot" + "copilot-spaces" ], - "operationId": "copilot/copilot-organization-users-one-day-usage-metrics", + "operationId": "copilot-spaces/delete-resource-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/resources#delete-a-resource-from-an-organization-copilot-space" }, "parameters": [ { @@ -182428,90 +183133,27 @@ } }, { - "name": "day", - "description": "The day to request data for, in `YYYY-MM-DD` format.", - "in": "query", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", "required": true, "schema": { - "type": "string", - "format": "date", - "examples": [ - "2025-10-13" - ] + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Copilot Metrics 1 Day Report", - "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", - "properties": { - "download_links": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." - }, - "report_day": { - "type": "string", - "format": "date", - "description": "The day of the report in `YYYY-MM-DD` format." - } - }, - "required": [ - "download_links", - "report_day" - ] - }, - "examples": { - "default": { - "value": { - "download_links": [ - "https://example.com/copilot-usage-report-1.json", - "https://example.com/copilot-usage-report-2.json" - ], - "report_day": "2025-07-01" - } - } - } - } - } - }, "204": { - "description": "A header with no content is returned." - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } + "description": "Response" }, "403": { "description": "Forbidden", @@ -182567,24 +183209,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage-metrics" + "category": "copilot-spaces", + "subcategory": "resources" } } }, - "/orgs/{org}/copilot/metrics/reports/users-28-day/latest": { + "/orgs/{org}/copilot/billing": { "get": { - "summary": "Get Copilot organization users usage metrics", - "description": "Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "summary": "Get Copilot seat information and settings for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], - "operationId": "copilot/copilot-organization-users-usage-metrics", + "operationId": "copilot/get-copilot-organization-details", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization" }, "parameters": [ { @@ -182599,48 +183240,124 @@ ], "responses": { "200": { - "description": "Response", + "description": "OK", "content": { "application/json": { "schema": { + "title": "Copilot Organization Details", + "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.", "type": "object", - "title": "Copilot Metrics 28 Day Report", - "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", "properties": { - "download_links": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." + "seat_breakdown": { + "title": "Copilot Seat Breakdown", + "description": "The breakdown of Copilot Business seats for the organization.", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "The total number of seats being billed for the organization as of the current billing cycle." + }, + "added_this_cycle": { + "type": "integer", + "description": "Seats added during the current billing cycle." + }, + "pending_cancellation": { + "type": "integer", + "description": "The number of seats that are pending cancellation at the end of the current billing cycle." + }, + "pending_invitation": { + "type": "integer", + "description": "The number of users who have been invited to receive a Copilot seat through this organization." + }, + "active_this_cycle": { + "type": "integer", + "description": "The number of seats that have used Copilot during the current billing cycle." + }, + "inactive_this_cycle": { + "type": "integer", + "description": "The number of seats that have not used Copilot during the current billing cycle." + } + } }, - "report_start_day": { + "public_code_suggestions": { "type": "string", - "format": "date", - "description": "The start date of the report period in `YYYY-MM-DD` format." + "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).", + "enum": [ + "allow", + "block", + "unconfigured" + ] }, - "report_end_day": { + "ide_chat": { "type": "string", - "format": "date", - "description": "The end date of the report period in `YYYY-MM-DD` format." + "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "platform_chat": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "cli": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot CLI.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "seat_management_setting": { + "type": "string", + "description": "The mode of assigning new seats.", + "enum": [ + "assign_all", + "assign_selected", + "disabled", + "unconfigured" + ] + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise" + ] } }, "required": [ - "download_links", - "report_start_day", - "report_end_day" - ] + "seat_breakdown", + "public_code_suggestions", + "seat_management_setting" + ], + "additionalProperties": true }, "examples": { "default": { "value": { - "download_links": [ - "https://example.com/copilot-usage-report-1.json", - "https://example.com/copilot-usage-report-2.json" - ], - "report_start_day": "2025-07-01", - "report_end_day": "2025-07-28" + "seat_breakdown": { + "total": 12, + "added_this_cycle": 9, + "pending_invitation": 0, + "pending_cancellation": 0, + "active_this_cycle": 12, + "inactive_this_cycle": 11 + }, + "seat_management_setting": "assign_selected", + "ide_chat": "enabled", + "platform_chat": "enabled", + "cli": "enabled", + "public_code_suggestions": "block", + "plan_type": "business" } } } @@ -182673,8 +183390,8 @@ } } }, - "403": { - "description": "Forbidden", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -182699,8 +183416,8 @@ } } }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -182724,267 +183441,6 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage-metrics" - } - } - }, - "/orgs/{org}/credential-authorizations": { - "get": { - "summary": "List SAML SSO authorizations for an organization", - "description": "Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/enterprise-cloud@latest//articles/about-authentication-with-saml-single-sign-on).\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/list-saml-sso-authorizations", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page token", - "in": "query", - "schema": { - "type": "integer" - } - }, - { - "name": "login", - "description": "Limits the list of credentials authorizations for an organization to a specific login", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Credential Authorization", - "description": "Credential Authorization", - "type": "object", - "properties": { - "login": { - "type": "string", - "description": "User login that owns the underlying credential.", - "examples": [ - "monalisa" - ] - }, - "credential_id": { - "type": "integer", - "description": "Unique identifier for the authorization of the credential. Use this to revoke authorization of the underlying token or key.", - "examples": [ - 1 - ] - }, - "credential_type": { - "type": "string", - "description": "Human-readable description of the credential type.", - "examples": [ - "SSH Key" - ] - }, - "token_last_eight": { - "type": "string", - "description": "Last eight characters of the credential. Only included in responses with credential_type of personal access token.", - "examples": [ - "12345678" - ] - }, - "credential_authorized_at": { - "type": "string", - "format": "date-time", - "description": "Date when the credential was authorized for use.", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "scopes": { - "type": "array", - "description": "List of oauth scopes the token has been granted.", - "items": { - "type": "string" - }, - "examples": [ - "user", - "repo" - ] - }, - "fingerprint": { - "type": "string", - "description": "Unique string to distinguish the credential. Only included in responses with credential_type of SSH Key.", - "examples": [ - "jklmnop12345678" - ] - }, - "credential_accessed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Date when the credential was last accessed. May be null if it was never accessed", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "authorized_credential_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the underlying token that was authorized by the user. This will remain unchanged across authorizations of the token.", - "examples": [ - 12345678 - ] - }, - "authorized_credential_title": { - "type": [ - "string", - "null" - ], - "description": "The title given to the ssh key. This will only be present when the credential is an ssh key.", - "examples": [ - "my ssh key" - ] - }, - "authorized_credential_note": { - "type": [ - "string", - "null" - ], - "description": "The note given to the token. This will only be present when the credential is a token.", - "examples": [ - "my token" - ] - }, - "authorized_credential_expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The expiry for the token. This will only be present when the credential is a token." - } - }, - "required": [ - "login", - "credential_id", - "credential_type", - "credential_authorized_at", - "credential_accessed_at", - "authorized_credential_id" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "login": "octocat", - "credential_id": 161195, - "credential_type": "personal access token", - "token_last_eight": "71c3fc11", - "credential_authorized_at": "2011-01-26T19:06:43Z", - "credential_accessed_at": "2011-01-26T19:06:43Z", - "authorized_credential_expires_at": "2011-02-25T19:06:43Z", - "scopes": [ - "user", - "repo" - ] - }, - { - "login": "hubot", - "credential_id": 161196, - "credential_type": "personal access token", - "token_last_eight": "Ae178B4a", - "credential_authorized_at": "2019-03-29T19:06:43Z", - "credential_accessed_at": "2011-01-26T19:06:43Z", - "authorized_credential_expires_at": "2019-04-28T19:06:43Z", - "scopes": [ - "repo" - ] - } - ] - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" - } - } - }, - "/orgs/{org}/credential-authorizations/{credential_id}": { - "delete": { - "summary": "Remove a SAML SSO authorization for an organization", - "description": "Removes a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/remove-saml-sso-authorization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "credential_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" }, "404": { "description": "Resource not found", @@ -183011,27 +183467,30 @@ } } } + }, + "422": { + "description": "There is a problem with your account's associated payment method." } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "copilot", + "subcategory": "copilot-user-management" } } }, - "/orgs/{org}/custom-repository-roles": { + "/orgs/{org}/copilot/billing/seats": { "get": { - "summary": "List custom repository roles in an organization", - "description": "List the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "summary": "List all Copilot seat assignments for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/reference/metrics-data).\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ - "orgs" + "copilot" ], - "operationId": "orgs/list-custom-repo-roles", + "operationId": "copilot/list-copilot-seats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" }, "parameters": [ { @@ -183042,248 +183501,732 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 50 + } } ], "responses": { "200": { - "description": "Response - list of custom role names", + "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { - "total_count": { - "description": "The number of custom roles in this organization", + "total_seats": { "type": "integer", - "examples": [ - 3 - ] + "description": "Total number of Copilot seats for the organization currently being billed." }, - "custom_roles": { + "seats": { "type": "array", "items": { - "title": "Organization Custom Repository Role", - "description": "Custom repository roles created by organization owners", + "title": "Copilot Business Seat Detail", + "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the custom role.", - "type": "integer" - }, - "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", - "null" - ] - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "assignee": { + "anyOf": [ + { + "type": "null" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ] + }, + "assigning_team": { + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", + "oneOf": [ + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent", + "type" + ] + }, + { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "description": "Retired: this field will not be returned with GHEC enterprise teams.", + "examples": [ + "disabled | all" + ] + }, + "organization_selection_type": { + "type": "string", + "examples": [ + "disabled | selected | all" + ] + }, + "group_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "62ab9291-fae2-468e-974b-7e45096d5021" + ] + }, + "group_name": { + "type": [ + "string", + "null" + ], + "description": "Retired: this field will not be returned with GHEC enterprise teams.", + "examples": [ + "Justice League" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/dc/teams/justice-league" + ] + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "name", + "html_url", + "slug", + "created_at", + "updated_at", + "group_id" + ] + } + ], + "type": [ + "null", + "object" ] }, + "pending_cancellation_date": { + "type": [ + "string", + "null" + ], + "format": "date", + "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." + }, + "last_activity_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + }, + "last_activity_editor": { + "type": [ + "string", + "null" + ], + "description": "Last editor that was used by the user for a GitHub Copilot completion." + }, + "last_authenticated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format." + }, "created_at": { "type": "string", - "format": "date-time" + "format": "date-time", + "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." }, "updated_at": { "type": "string", - "format": "date-time" + "format": "date-time", + "deprecated": true, + "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise", + "unknown" + ] } }, "required": [ - "id", - "name", - "base_role", - "permissions", - "organization", - "created_at", - "updated_at" - ] + "created_at" + ], + "additionalProperties": false } } } @@ -183291,100 +184234,219 @@ "examples": { "default": { "value": { - "total_count": 2, - "custom_roles": [ + "total_seats": 2, + "seats": [ { - "id": 8030, - "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", + "created_at": "2021-08-03T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": null, + "last_activity_at": "2021-10-14T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "last_authenticated_at": "2021-10-14T00:53:32-06:00", + "plan_type": "business", + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", "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", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", "site_admin": false }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:20:11Z" + "assigning_team": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } }, { - "id": 8031, - "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", + "created_at": "2021-09-23T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": "2021-11-01", + "last_activity_at": "2021-10-13T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "last_authenticated_at": "2021-10-14T00:53:32-06:00", + "assignee": { + "login": "octokitten", + "id": 1, + "node_id": "MDQ76VNlcjE=", + "avatar_url": "https://github.com/images/error/octokitten_happy.gif", "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", + "url": "https://api.github.com/users/octokitten", + "html_url": "https://github.com/octokitten", + "followers_url": "https://api.github.com/users/octokitten/followers", + "following_url": "https://api.github.com/users/octokitten/following{/other_user}", + "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", + "organizations_url": "https://api.github.com/users/octokitten/orgs", + "repos_url": "https://api.github.com/users/octokitten/repos", + "events_url": "https://api.github.com/users/octokitten/events{/privacy}", + "received_events_url": "https://api.github.com/users/octokitten/received_events", + "type": "User", "site_admin": false - }, - "created_at": "2022-07-05T12:01:11Z", - "updated_at": "2022-07-05T12:20:11Z" + } } ] } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } } } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "custom-roles" + "category": "copilot", + "subcategory": "copilot-user-management" } - }, + } + }, + "/orgs/{org}/copilot/billing/selected_teams": { "post": { - "summary": "Create a custom repository role", - "description": "Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Add teams to the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ - "orgs" + "copilot" ], - "operationId": "orgs/create-custom-repo-role", + "operationId": "copilot/add-copilot-seats-for-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization" }, "parameters": [ { @@ -183398,335 +184460,74 @@ } ], "requestBody": { - "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "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", - "null" - ] - }, - "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.", + "selected_teams": { "type": "array", + "description": "List of team names within the organization to which to grant access to GitHub Copilot.", "items": { "type": "string" - } + }, + "minItems": 1 } }, "required": [ - "name", - "base_role", - "permissions" + "selected_teams" ] }, "examples": { "default": { "value": { - "name": "Labeler", - "description": "A role for issue and pull request labelers", - "base_role": "read", - "permissions": [ - "add_label" + "selected_teams": [ + "engteam1", + "engteam2", + "engteam3" ] } } } } - } + }, + "required": true }, "responses": { "201": { - "description": "Response", + "description": "OK", "content": { "application/json": { "schema": { - "title": "Organization Custom Repository Role", - "description": "Custom repository roles created by organization owners", "type": "object", + "description": "The total number of seats created for members of the specified team(s).", "properties": { - "id": { - "description": "The unique identifier of the custom role.", + "seats_created": { "type": "integer" - }, - "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", - "null" - ] - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" } }, "required": [ - "id", - "name", - "base_role", - "permissions", - "organization", - "created_at", - "updated_at" + "seats_created" ] }, "examples": { "default": { "value": { - "id": 8030, - "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": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:20:11Z" + "seats_created": 5 } } } } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -183734,64 +184535,19 @@ "documentation_url": { "type": "string" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } }, - "404": { - "description": "Resource not found", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -183815,303 +184571,27 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "custom-roles" - } - } - }, - "/orgs/{org}/custom-repository-roles/{role_id}": { - "get": { - "summary": "Get a custom repository role", - "description": "Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/get-custom-repo-role", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "role_id", - "description": "The unique identifier of the role.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Organization Custom Repository Role", - "description": "Custom repository roles created by organization owners", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the custom role.", - "type": "integer" - }, - "name": { - "description": "The name of the custom role.", + "message": { "type": "string" }, - "description": { - "description": "A short description about who this role is for or what permissions it grants.", - "type": [ - "string", - "null" - ] - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "documentation_url": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time" + "url": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "base_role", - "permissions", - "organization", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 8030, - "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": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:20:11Z" + "status": { + "type": "string" } } } @@ -184143,25 +184623,28 @@ } } } + }, + "422": { + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "custom-roles" + "category": "copilot", + "subcategory": "copilot-user-management" } }, - "patch": { - "summary": "Update a custom repository role", - "description": "Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "delete": { + "summary": "Remove teams from the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ - "orgs" + "copilot" ], - "operationId": "orgs/update-custom-repo-role", + "operationId": "copilot/cancel-copilot-seat-assignment-for-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization" }, "parameters": [ { @@ -184172,343 +184655,77 @@ "schema": { "type": "string" } - }, - { - "name": "role_id", - "description": "The unique identifier of the role.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { - "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "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", - "null" - ] - }, - "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.", + "selected_teams": { "type": "array", + "description": "The names of teams from which to revoke access to GitHub Copilot.", "items": { "type": "string" - } + }, + "minItems": 1 } - } + }, + "required": [ + "selected_teams" + ] }, "examples": { "default": { "value": { - "name": "Labeler", - "description": "A role for issue and PR labelers", - "base_role": "read", - "permissions": [ - "add_label", - "remove_label" + "selected_teams": [ + "engteam1", + "engteam2", + "engteam3" ] } } } } - } + }, + "required": true }, "responses": { "200": { - "description": "Response", + "description": "OK", "content": { "application/json": { "schema": { - "title": "Organization Custom Repository Role", - "description": "Custom repository roles created by organization owners", "type": "object", + "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", "properties": { - "id": { - "description": "The unique identifier of the custom role.", + "seats_cancelled": { "type": "integer" - }, - "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", - "null" - ] - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" } }, "required": [ - "id", - "name", - "base_role", - "permissions", - "organization", - "created_at", - "updated_at" + "seats_cancelled" ] }, "examples": { "default": { "value": { - "id": 8030, - "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": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:20:11Z" + "seats_cancelled": 5 } } } } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -184516,56 +184733,63 @@ "documentation_url": { "type": "string" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -184597,25 +184821,30 @@ } } } + }, + "422": { + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "custom-roles" + "category": "copilot", + "subcategory": "copilot-user-management" } - }, - "delete": { - "summary": "Delete a custom repository role", - "description": "Deletes 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. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + } + }, + "/orgs/{org}/copilot/billing/selected_users": { + "post": { + "summary": "Add users to the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ - "orgs" + "copilot" ], - "operationId": "orgs/delete-custom-repo-role", + "operationId": "copilot/add-copilot-seats-for-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization" }, "parameters": [ { @@ -184626,41 +184855,194 @@ "schema": { "type": "string" } - }, - { - "name": "role_id", - "description": "The unique identifier of the role.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members to be granted access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "selected_usernames" + ] + }, + "examples": { + "default": { + "value": { + "selected_usernames": [ + "cooluser1", + "hacker2", + "octocat" + ] + } + } + } + } + }, + "required": true + }, "responses": { - "204": { - "description": "Response" + "201": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The total number of seats created for the specified user(s).", + "properties": { + "seats_created": { + "type": "integer" + } + }, + "required": [ + "seats_created" + ] + }, + "examples": { + "default": { + "value": { + "seats_created": 5 + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "custom-roles" + "category": "copilot", + "subcategory": "copilot-user-management" } - } - }, - "/orgs/{org}/custom_roles": { - "post": { - "summary": "Closing down - Create a custom role", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[Create a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role)\" endpoint instead.\n\nCreates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + }, + "delete": { + "summary": "Remove users from the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ - "orgs" + "copilot" ], - "operationId": "orgs/create-custom-role", + "operationId": "copilot/cancel-copilot-seat-assignment-for-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---create-a-custom-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization" }, "parameters": [ { @@ -184674,335 +185056,74 @@ } ], "requestBody": { - "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "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", - "null" - ] - }, - "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.", + "selected_usernames": { "type": "array", + "description": "The usernames of the organization members for which to revoke access to GitHub Copilot.", "items": { "type": "string" - } + }, + "minItems": 1 } }, "required": [ - "name", - "base_role", - "permissions" + "selected_usernames" ] }, "examples": { "default": { "value": { - "name": "Labeler", - "description": "A role for issue and pull request labelers", - "base_role": "read", - "permissions": [ - "add_label" + "selected_usernames": [ + "cooluser1", + "hacker2", + "octocat" ] } } } } - } + }, + "required": true }, "responses": { - "201": { - "description": "Response", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "title": "Organization Custom Repository Role", - "description": "Custom repository roles created by organization owners", "type": "object", + "description": "The total number of seats set to \"pending cancellation\" for the specified users.", "properties": { - "id": { - "description": "The unique identifier of the custom role.", + "seats_cancelled": { "type": "integer" - }, - "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", - "null" - ] - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" } }, "required": [ - "id", - "name", - "base_role", - "permissions", - "organization", - "created_at", - "updated_at" + "seats_cancelled" ] }, "examples": { "default": { "value": { - "id": 8030, - "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": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:20:11Z" + "seats_cancelled": 5 } } } } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -185010,56 +185131,63 @@ "documentation_url": { "type": "string" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -185091,30 +185219,30 @@ } } } + }, + "422": { + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team." } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2023-09-06", - "deprecationDate": "2023-03-06", - "category": "orgs", - "subcategory": "custom-roles" - }, - "deprecated": true + "category": "copilot", + "subcategory": "copilot-user-management" + } } }, - "/orgs/{org}/custom_roles/{role_id}": { + "/orgs/{org}/copilot/coding-agent/permissions": { "get": { - "summary": "Closing down - Get a custom role", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[Get a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role)\" endpoint instead.\n\nGets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "summary": "Get Copilot cloud agent permissions for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about which repositories in an organization have been enabled\nor disabled for the Copilot cloud agent.\n\nOrganization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "copilot" ], - "operationId": "orgs/get-custom-role", + "operationId": "copilot/get-copilot-coding-agent-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---get-a-custom-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#get-copilot-cloud-agent-permissions-for-an-organization" }, "parameters": [ { @@ -185125,15 +185253,6 @@ "schema": { "type": "string" } - }, - { - "name": "role_id", - "description": "The unique identifier of the role.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -185142,255 +185261,122 @@ "content": { "application/json": { "schema": { - "title": "Organization Custom Repository Role", - "description": "Custom repository roles created by organization owners", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the custom role.", - "type": "integer" - }, - "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", - "null" - ] - }, - "base_role": { + "enabled_repositories": { "type": "string", - "description": "The system role from which this role inherits permissions.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ - "read", - "triage", - "write", - "maintain" - ] - }, - "permissions": { - "description": "A list of additional permissions included in this role.", - "type": "array", - "items": { - "type": "string" - } - }, - "organization": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "all", + "selected", + "none" ] }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { + "selected_repositories_url": { "type": "string", - "format": "date-time" + "description": "The URL for the selected repositories endpoint. Only present when `enabled_repositories` is `selected`." } }, "required": [ - "id", - "name", - "base_role", - "permissions", - "organization", - "created_at", - "updated_at" + "enabled_repositories" ] }, "examples": { - "default": { + "all_enabled": { + "summary": "All repositories enabled", "value": { - "id": 8030, - "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": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:20:11Z" + "enabled_repositories": "all" + } + }, + "selected_enabled": { + "summary": "Selected repositories enabled", + "value": { + "enabled_repositories": "selected", + "selected_repositories_url": "https://api.github.com/orgs/my-org/copilot/coding-agent/permissions/repositories" + } + }, + "none_enabled": { + "summary": "No repositories enabled", + "value": { + "enabled_repositories": "none" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -185425,25 +185411,22 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2022-09-06", - "deprecationDate": "2023-03-06", - "category": "orgs", - "subcategory": "custom-roles" - }, - "deprecated": true + "category": "copilot", + "subcategory": "copilot-coding-agent-management" + } }, - "patch": { - "summary": "Closing down - Update a custom role", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[Update a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role)\" endpoint instead.\n\nUpdates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "put": { + "summary": "Set Copilot cloud agent permissions for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets the policy for which repositories in an organization can use Copilot cloud agent.\n\nOrganization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "copilot" ], - "operationId": "orgs/update-custom-role", + "operationId": "copilot/set-copilot-coding-agent-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---update-a-custom-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#set-copilot-cloud-agent-permissions-for-an-organization" }, "parameters": [ { @@ -185454,15 +185437,6 @@ "schema": { "type": "string" } - }, - { - "name": "role_id", - "description": "The unique identifier of the role.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -185472,46 +185446,24 @@ "schema": { "type": "object", "properties": { - "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", - "null" - ] - }, - "base_role": { + "enabled_repositories": { "type": "string", - "description": "The system role from which this role inherits permissions.", + "description": "The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.", "enum": [ - "read", - "triage", - "write", - "maintain" + "all", + "selected", + "none" ] - }, - "permissions": { - "description": "A list of additional permissions included in this role.", - "type": "array", - "items": { - "type": "string" - } } - } + }, + "required": [ + "enabled_repositories" + ] }, "examples": { "default": { "value": { - "name": "Labeler", - "description": "A role for issue and PR labelers", - "base_role": "read", - "permissions": [ - "add_label", - "remove_label" - ] + "enabled_repositories": "selected" } } } @@ -185519,260 +185471,107 @@ } }, "responses": { - "200": { - "description": "Response", + "204": { + "description": "No Content" + }, + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { - "title": "Organization Custom Repository Role", - "description": "Custom repository roles created by organization owners", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the custom role.", - "type": "integer" + "message": { + "type": "string" }, - "name": { - "description": "The name of the custom role.", + "documentation_url": { "type": "string" }, - "description": { - "description": "A short description about who this role is for or what permissions it grants.", - "type": [ - "string", - "null" - ] + "url": { + "type": "string" }, - "base_role": { - "type": "string", - "description": "The system role from which this role inherits permissions.", - "enum": [ - "read", - "triage", - "write", - "maintain" - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "permissions": { - "description": "A list of additional permissions included in this role.", - "type": "array", - "items": { - "type": "string" - } + "documentation_url": { + "type": "string" }, - "organization": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "url": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time" + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time" + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } - }, - "required": [ - "id", - "name", - "base_role", - "permissions", - "organization", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 8030, - "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": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:20:11Z" + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -185853,102 +185652,27 @@ } } } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "removalDate": "2022-09-06", - "deprecationDate": "2023-03-06", - "category": "orgs", - "subcategory": "custom-roles" - }, - "deprecated": true - }, - "delete": { - "summary": "Closing down - Delete a custom role", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[Delete a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role)\" endpoint instead.\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. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/delete-custom-role", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---delete-a-custom-role" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role_id", - "description": "The unique identifier of the role.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2022-09-06", - "deprecationDate": "2023-03-06", - "category": "orgs", - "subcategory": "custom-roles" - }, - "deprecated": true + "category": "copilot", + "subcategory": "copilot-coding-agent-management" + } } }, - "/orgs/{org}/dependabot/alerts": { + "/orgs/{org}/copilot/coding-agent/permissions/repositories": { "get": { - "summary": "List Dependabot alerts for an organization", - "description": "Lists Dependabot alerts for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "summary": "List repositories enabled for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists the selected repositories that are enabled for Copilot cloud agent in an organization.\n\nOrganization owners can use this endpoint when the coding agent repository policy\nis set to `selected` to see which repositories have been enabled.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/list-alerts-for-org", + "operationId": "copilot/list-copilot-coding-agent-selected-repositories-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -185961,172 +185685,21 @@ } }, { - "name": "classification", - "in": "query", - "description": "A comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned.\n\nCan be: `malware`, `general`", - "schema": { - "type": "string" - } - }, - { - "name": "state", - "in": "query", - "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`", - "schema": { - "type": "string" - } - }, - { - "name": "severity", - "in": "query", - "description": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`", - "schema": { - "type": "string" - } - }, - { - "name": "ecosystem", - "in": "query", - "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`", - "schema": { - "type": "string" - } - }, - { - "name": "package", - "in": "query", - "description": "A comma-separated list of package names. If specified, only alerts for these packages will be returned.", - "schema": { - "type": "string" - } - }, - { - "name": "epss_percentage", - "in": "query", - "description": "CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.", - "schema": { - "type": "string" - } - }, - { - "name": "artifact_registry_url", - "in": "query", - "description": "A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.", - "schema": { - "type": "string" - } - }, - { - "name": "artifact_registry", - "in": "query", - "description": "A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned.\n\nCan be: `jfrog-artifactory`", - "schema": { - "type": "string" - } - }, - { - "name": "has", - "in": "query", - "description": "Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple `has` filters can be passed to filter for alerts that have all of the values.", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "patch", - "deployment" - ] - } - } - ] - } - }, - { - "name": "assignee", - "in": "query", - "description": "Filter alerts by assignees.\nProvide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users.\nUse `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.", - "schema": { - "type": "string" - } - }, - { - "name": "runtime_risk", - "in": "query", - "description": "A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned.\n\nCan be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement`", - "schema": { - "type": "string" - } - }, - { - "name": "scope", - "in": "query", - "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.", - "schema": { - "type": "string", - "enum": [ - "development", - "runtime" - ] - } - }, - { - "name": "sort", - "in": "query", - "description": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.", - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "epss_percentage" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", - "required": false, "schema": { - "type": "string" + "type": "integer", + "default": 30 } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", - "default": 30 + "default": 1 } } ], @@ -186136,1487 +185709,905 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "description": "A Dependabot alert.", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the Dependabot alert.", - "readOnly": true, - "enum": [ - "auto_dismissed", - "dismissed", - "fixed", - "open" - ] - }, - "dependency": { + "type": "object", + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, "properties": { - "package": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, "properties": { - "ecosystem": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true + "examples": [ + "octocat" + ] }, - "name": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "manifest_path": { + "private": { + "type": "boolean" + }, + "html_url": { "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] }, - "scope": { + "description": { "type": [ "string", "null" ], - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "enum": [ - "development", - "runtime", - null + "examples": [ + "This your first repo!" ] }, - "relationship": { - "type": [ - "string", - "null" - ], - "description": "The vulnerable dependency's relationship to your project.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.\n", - "readOnly": true, - "enum": [ - "unknown", - "direct", - "transitive", - "inconclusive", - null + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" ] - } - } - }, - "security_advisory": { - "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, - "properties": { - "ghsa_id": { + }, + "archive_url": { "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] }, - "summary": { + "blobs_url": { "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] }, - "description": { + "branches_url": { "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - } + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] }, - "severity": { + "comments_url": { "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, - "classification": { + "commits_url": { "type": "string", - "description": "The classification of the advisory.", - "readOnly": true, - "enum": [ - "general", - "malware" - ] - }, - "cvss": { - "type": "object", - "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", - "readOnly": true, - "properties": { - "score": { - "type": "number", - "description": "The overall CVSS score of the advisory.", - "minimum": 0, - "maximum": 10, - "readOnly": true - }, - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The full CVSS vector string for the advisory.", - "readOnly": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false - }, - "cvss_severities": { - "type": [ - "object", - "null" - ], - "properties": { - "cvss_v3": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 3 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 4 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - } - } - }, - "epss": { - "type": [ - "object", - "null" - ], - "readOnly": true, - "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", - "properties": { - "percentage": { - "type": "number", - "minimum": 0, - "maximum": 100 - }, - "percentile": { - "type": "number", - "minimum": 0, - "maximum": 100 - } - } - }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } - }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { - "type": "object", - "description": "An advisory identifier.", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true - } - }, - "required": [ - "value", - "type" - ], - "additionalProperties": false - } - }, - "references": { - "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, - "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } - }, - "required": [ - "url" - ], - "additionalProperties": false - } - }, - "published_at": { - "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - } - }, - "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", - "severity", - "cvss", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false - }, - "security_vulnerability": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "created_at": { - "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "The reason that the alert was dismissed.", - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment associated with the alert's dismissal.", - "maxLength": 280 - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "auto_dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissal_request": { - "title": "Dependabot alert dismissal request", - "description": "Information about an active dismissal request for this Dependabot alert.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the dismissal request." - }, - "status": { - "type": "string", - "description": "The current status of the dismissal request.", - "enum": [ - "pending", - "approved", - "rejected", - "cancelled" - ] - }, - "requester": { - "type": "object", - "description": "The user who requested the dismissal.", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the user." - }, - "login": { - "type": "string", - "description": "The login name of the user." - } - } - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time when the dismissal request was created." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The API URL to get more information about this dismissal request." - } - } - }, - "assignees": { - "type": "array", - "description": "The users assigned to this alert.", - "readOnly": true, - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", - "description": "A template for the API URL to compare two commits or refs.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", - "description": "A template for the API URL to get the contents of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", - "description": "The API URL to list the deployments of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", - "description": "The API URL to list the downloads on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", - "description": "The API URL to list the events of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", - "description": "The API URL to list the forks of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, + "git_url": { + "type": "string" + }, "issue_comment_url": { "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", - "description": "The API URL to get information about the languages of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", - "description": "The API URL to merge branches in the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, + "ssh_url": { + "type": "string" + }, "stargazers_url": { "type": "string", "format": "uri", - "description": "The API URL to list the stargazers on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", - "description": "The API URL to list the subscribers on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", - "description": "The API URL to get information about tags on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" + "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", - "description": "The API URL to list the teams on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" + "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" ] }, "hooks_url": { "type": "string", "format": "uri", - "description": "The API URL to list the hooks on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "has_pull_requests": { + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_validity_checks": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + }, + "mode": { + "type": "string", + "description": "The bypass mode for the reviewer", + "enum": [ + "ALWAYS", + "EXEMPT" + ], + "default": "ALWAYS" + } + } + } + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -187668,167 +186659,24 @@ "url" ] } - }, - "required": [ - "number", - "state", - "dependency", - "security_advisory", - "security_vulnerability", - "url", - "html_url", - "created_at", - "updated_at", - "dismissed_at", - "dismissed_by", - "dismissed_reason", - "dismissed_comment", - "fixed_at", - "repository" - ], - "additionalProperties": false - } + } + }, + "required": [ + "total_count", + "repositories" + ] }, "examples": { "default": { - "value": [ - { - "number": 2, - "state": "dismissed", - "dependency": { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "manifest_path": "path/to/requirements.txt", - "scope": "runtime" - }, - "security_advisory": { - "ghsa_id": "GHSA-rf4j-j272-fj86", - "cve_id": "CVE-2018-6188", - "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", - "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 2.0.0, < 2.0.2", - "first_patched_version": { - "identifier": "2.0.2" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 1.11.8, < 1.11.10", - "first_patched_version": { - "identifier": "1.11.10" - } - } - ], - "severity": "high", - "cvss": { - "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", - "score": 7.5 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", - "score": 7.5 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", - "score": 8.7 - } - }, - "epss": { - "percentage": 0.00045, - "percentile": "0.16001e0" - }, - "cwes": [ - { - "cwe_id": "CWE-200", - "name": "Exposure of Sensitive Information to an Unauthorized Actor" - } - ], - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-rf4j-j272-fj86" - }, - { - "type": "CVE", - "value": "CVE-2018-6188" - } - ], - "references": [ - { - "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" - }, - { - "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" - }, - { - "url": "https://usn.ubuntu.com/3559-1/" - }, - { - "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" - }, - { - "url": "http://www.securitytracker.com/id/1040422" - } - ], - "published_at": "2018-10-03T21:13:54Z", - "updated_at": "2022-04-26T18:35:37Z", - "withdrawn_at": null - }, - "security_vulnerability": { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 2.0.0, < 2.0.2", - "first_patched_version": { - "identifier": "2.0.2" - } - }, - "url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2", - "html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2", - "created_at": "2022-06-15T07:43:03Z", - "updated_at": "2022-08-23T14:29:47Z", - "dismissed_at": "2022-08-23T14:29:47Z", - "dismissed_by": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "dismissed_reason": "tolerable_risk", - "dismissed_comment": "This alert is accurate but we use a sanitizer.", - "fixed_at": null, - "assignees": [ - { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -187847,273 +186695,232 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } - ], - "repository": { - "id": 217723378, - "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", - "name": "octo-repo", - "full_name": "octo-org/octo-repo", - "owner": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false }, - "private": true, - "html_url": "https://github.com/octo-org/octo-repo", - "description": null, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", "fork": false, - "url": "https://api.github.com/repos/octo-org/octo-repo", - "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", - "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", - "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", - "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", - "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", - "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", - "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}" - } - }, - { - "number": 1, - "state": "open", - "dependency": { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "manifest_path": "path/to/requirements.txt", - "scope": "runtime" - }, - "security_advisory": { - "ghsa_id": "GHSA-8f4m-hccc-8qph", - "cve_id": "CVE-2021-20191", - "summary": "Insertion of Sensitive Information into Log File in ansible", - "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": ">= 2.9.0, < 2.9.18", - "first_patched_version": { - "identifier": "2.9.18" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { - "identifier": "2.8.19" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": ">= 2.10.0, < 2.10.7", - "first_patched_version": { - "identifier": "2.10.7" - } - } + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" ], - "severity": "medium", - "cvss": { - "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", - "score": 5.5 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", - "score": 5.5 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", - "score": 8.5 - } + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true }, - "cwes": [ - { - "cwe_id": "CWE-532", - "name": "Insertion of Sensitive Information into Log File" - } - ], - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-8f4m-hccc-8qph" - }, - { - "type": "CVE", - "value": "CVE-2021-20191" - } - ], - "references": [ - { - "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" - }, - { - "url": "https://access.redhat.com/security/cve/cve-2021-20191" + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false }, - { - "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" - } - ], - "published_at": "2021-06-01T17:38:00Z", - "updated_at": "2021-08-12T23:06:00Z", - "withdrawn_at": null - }, - "security_vulnerability": { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { - "identifier": "2.8.19" - } - }, - "url": "https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1", - "html_url": "https://github.com/octo-org/hello-world/security/dependabot/1", - "created_at": "2022-06-14T15:21:52Z", - "updated_at": "2022-06-14T15:21:52Z", - "dismissed_at": null, - "dismissed_by": null, - "dismissed_reason": null, - "dismissed_comment": null, - "fixed_at": null, - "assignees": [], - "repository": { - "id": 664700648, - "node_id": "MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=", - "name": "hello-world", - "full_name": "octo-org/hello-world", - "owner": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "organization": null, + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 }, - "private": true, - "html_url": "https://github.com/octo-org/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octo-org/hello-world", - "archive_url": "https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octo-org/hello-world/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octo-org/hello-world/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octo-org/hello-world/comments{/number}", - "commits_url": "https://api.github.com/repos/octo-org/hello-world/commits{/sha}", - "compare_url": "https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octo-org/hello-world/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octo-org/hello-world/contributors", - "deployments_url": "https://api.github.com/repos/octo-org/hello-world/deployments", - "downloads_url": "https://api.github.com/repos/octo-org/hello-world/downloads", - "events_url": "https://api.github.com/repos/octo-org/hello-world/events", - "forks_url": "https://api.github.com/repos/octo-org/hello-world/forks", - "git_commits_url": "https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}", - "hooks_url": "https://api.github.com/repos/octo-org/hello-world/hooks", - "issue_comment_url": "https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octo-org/hello-world/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octo-org/hello-world/issues{/number}", - "keys_url": "https://api.github.com/repos/octo-org/hello-world/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octo-org/hello-world/labels{/name}", - "languages_url": "https://api.github.com/repos/octo-org/hello-world/languages", - "merges_url": "https://api.github.com/repos/octo-org/hello-world/merges", - "milestones_url": "https://api.github.com/repos/octo-org/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octo-org/hello-world/pulls{/number}", - "releases_url": "https://api.github.com/repos/octo-org/hello-world/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octo-org/hello-world/stargazers", - "statuses_url": "https://api.github.com/repos/octo-org/hello-world/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octo-org/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/hello-world/subscription", - "tags_url": "https://api.github.com/repos/octo-org/hello-world/tags", - "teams_url": "https://api.github.com/repos/octo-org/hello-world/teams", - "trees_url": "https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}" + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 } - } - ] + ] + } } } } } }, - "304": { - "description": "Not modified" - }, - "400": { - "description": "Bad Request", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -188135,45 +186942,29 @@ } } } - }, - "application/scim+json": { + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { "schema": { - "title": "Scim Error", - "description": "Scim Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { "message": { - "type": [ - "string", - "null" - ] + "type": "string" }, "documentation_url": { - "type": [ - "string", - "null" - ] + "type": "string" }, - "detail": { - "type": [ - "string", - "null" - ] + "url": { + "type": "string" }, "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } + "type": "string" } } } @@ -188232,18 +187023,14 @@ } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -188251,11 +187038,11 @@ "documentation_url": { "type": "string" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -188266,22 +187053,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "alerts" + "category": "copilot", + "subcategory": "copilot-coding-agent-management" } - } - }, - "/orgs/{org}/dependabot/repository-access": { - "get": { - "summary": "Lists the repositories Dependabot can access in an organization", - "description": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.", + }, + "put": { + "summary": "Set selected repositories for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReplaces the list of selected repositories that are enabled for Copilot cloud\nagent in an organization. This method can only be called when the cloud agent\nrepository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/repository-access-for-org", + "operationId": "copilot/set-copilot-coding-agent-selected-repositories-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -188292,697 +187077,91 @@ "schema": { "type": "string" } - }, - { - "name": "page", - "in": "query", - "description": "The page number of results to fetch.", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "default": 1 - } - }, - { - "name": "per_page", - "in": "query", - "description": "Number of results per page.", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "description": "List of repository IDs to enable for Copilot cloud agent.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 32, + 42 + ] + } + } + } + } + } + }, "responses": { - "200": { - "description": "Response", + "204": { + "description": "No Content" + }, + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { - "title": "Dependabot Repository Access Details", - "description": "Information about repositories that Dependabot is able to access in an organization", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "default_level": { - "type": [ - "string", - "null" - ], - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal", - null - ], - "examples": [ - "internal" - ] + "message": { + "type": "string" }, - "accessible_repositories": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" - ] - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - } - ] - } + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } - }, - "additionalProperties": false - }, - "examples": { - "default": { - "value": { - "default_level": "public", - "accessible_repositories": [ - { - "id": 123456, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", - "name": "example-repo", - "full_name": "octocat/example-repo", - "owner": { - "name": "octocat", - "email": "octo@github.com", - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", - "gravatar_id": 1, - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat/example-repo", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false, - "starred_at": "\"2020-07-09T00:17:55Z\"", - "user_view_type": "default" - }, - "private": false, - "html_url": "https://github.com/octocat/example-repo", - "description": "This is an example repository.", - "fork": false, - "url": "https://api.github.com/repos/octocat/example-repo", - "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", - "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", - "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", - "events_url": "https://api.github.com/repos/octocat/example-repo/events", - "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", - "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", - "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", - "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", - "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", - "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", - "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", - "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", - "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" - } - ] + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -189040,25 +187219,128 @@ } } } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "copilot", + "subcategory": "copilot-coding-agent-management" } - }, - "patch": { - "summary": "Updates Dependabot's repository access list for an organization", - "description": "Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.\n\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", + } + }, + "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}": { + "put": { + "summary": "Enable a repository for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nAdds a repository to the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/update-repository-access-for-org", + "operationId": "copilot/enable-copilot-coding-agent-for-repository-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -189069,68 +187351,72 @@ "schema": { "type": "string" } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "repository_ids_to_add": { - "type": "array", - "items": { - "type": "integer" + "responses": { + "204": { + "description": "No Content" + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "description": "List of repository IDs to add." - }, - "repository_ids_to_remove": { - "type": "array", - "items": { - "type": "integer" + "documentation_url": { + "type": "string" }, - "description": "List of repository IDs to remove." + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } - }, - "example": { - "repository_ids_to_add": [ - 123, - 456 - ], - "repository_ids_to_remove": [ - 789 - ] } - }, - "examples": { - "204": { - "summary": "Example with a 'succeeded' status." - }, - "add-example": { - "summary": "Add repositories", - "value": { - "repository_ids_to_add": [ - 123, - 456 - ] - } - }, - "remove-example": { - "summary": "Remove repositories", - "value": { - "repository_ids_to_remove": [ - 789 - ] + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } } } } - } - }, - "responses": { - "204": { - "description": "Response" }, "403": { "description": "Forbidden", @@ -189183,27 +187469,126 @@ } } } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "copilot", + "subcategory": "copilot-coding-agent-management" } - } - }, - "/orgs/{org}/dependabot/repository-access/default-level": { - "put": { - "summary": "Set the default repository access level for Dependabot", - "description": "Sets the default level of repository access Dependabot will have while performing an update. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.\n\nThis operation supports both server-to-server and user-to-server access.", + }, + "delete": { + "summary": "Disable a repository for Copilot cloud agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemoves a repository from the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/set-repository-access-default-level", + "operationId": "copilot/disable-copilot-coding-agent-for-repository-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-cloud-agent-in-an-organization" }, "parameters": [ { @@ -189214,45 +187599,72 @@ "schema": { "type": "string" } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "default_level": { - "type": "string", - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal" - ], - "examples": [ - "internal" - ] + "responses": { + "204": { + "description": "No Content" + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } - }, - "required": [ - "default_level" - ] - }, - "examples": { - "204": { - "summary": "Example with a 'succeeded' status.", - "value": { - "default_level": "public" + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } } } } - } - }, - "responses": { - "204": { - "description": "Response" }, "403": { "description": "Forbidden", @@ -189305,27 +187717,53 @@ } } } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "copilot", + "subcategory": "copilot-coding-agent-management" } } }, - "/orgs/{org}/dependabot/secrets": { + "/orgs/{org}/copilot/content_exclusion": { "get": { - "summary": "List organization secrets", - "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Get Copilot content exclusion rules for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot content exclusion path rules.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can view details about Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `copilot` or `read:org` scopes to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.\n> * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/list-org-secrets", + "operationId": "copilot/copilot-content-exclusion-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization" }, "parameters": [ { @@ -189336,300 +187774,135 @@ "schema": { "type": "string" } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], "responses": { "200": { - "description": "Response", + "description": "OK", "content": { "application/json": { "schema": { + "title": "Copilot Organization Content Exclusion Details", + "description": "List all Copilot Content Exclusion rules for an organization.", "type": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "title": "Dependabot Secret for an Organization", - "description": "Secrets for GitHub Dependabot for an organization.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" - ] - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - } + "additionalProperties": { + "type": "array", + "items": { + "type": "string", + "description": "The path to the file that will be excluded." } } }, "examples": { "default": { "value": { - "total_count": 3, - "secrets": [ - { - "name": "MY_ARTIFACTORY_PASSWORD", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2021-12-10T14:59:22Z", - "visibility": "private" - }, - { - "name": "NPM_TOKEN", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2021-12-10T14:59:22Z", - "visibility": "all" - }, - { - "name": "GH_TOKEN", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2021-12-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories" - } + "octo-repo": [ + "/src/some-dir/kernel.rs" ] } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/dependabot/secrets/public-key": { - "get": { - "summary": "Get an organization public key", - "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/get-org-public-key", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", + }, + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { - "title": "DependabotPublicKey", - "description": "The public key used for setting Dependabot Secrets.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string", - "examples": [ - "1234567" - ] + "message": { + "type": "string" }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "examples": [ - "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" - ] - } - }, - "required": [ - "key_id", - "key" - ] - }, - "examples": { - "default": { - "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/dependabot/secrets/{secret_name}": { - "get": { - "summary": "Get an organization secret", - "description": "Gets a single organization secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/get-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Dependabot Secret for an Organization", - "description": "Secrets for GitHub Dependabot for an organization.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" + "message": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time" + "documentation_url": { + "type": "string" }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], + "url": { "type": "string" }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" - ] + "status": { + "type": "string" } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - }, - "examples": { - "default": { - "value": { - "name": "NPM_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories" + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -189640,20 +187913,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-content-exclusion-management" } }, "put": { - "summary": "Create or update an organization secret", - "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Set Copilot content exclusion rules for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets Copilot content exclusion path rules for an organization.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can set Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.\n> * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.", "tags": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/create-or-update-org-secret", + "operationId": "copilot/set-copilot-content-exclusion-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization" }, "parameters": [ { @@ -189664,70 +187937,63 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { + "description": "The content exclusion rules to set", "required": true, "content": { "application/json": { "schema": { "type": "object", - "properties": { - "encrypted_value": { - "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key) endpoint.", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "type": "string", - "description": "ID of the key you used to encrypt the secret." - }, - "visibility": { - "type": "string", - "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "enum": [ - "all", - "private", - "selected" - ] - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", - "items": { - "anyOf": [ - { - "type": "integer" + "additionalProperties": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string", + "description": "The path to the file that will be excluded." + }, + { + "type": "object", + "properties": { + "ifAnyMatch": { + "type": "array", + "items": { + "type": "string" + } + } }, - { - "type": "string" - } - ] - } + "required": [ + "ifAnyMatch" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ifNoneMatch": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "ifNoneMatch" + ], + "additionalProperties": false + } + ] } - }, - "required": [ - "visibility" - ] + } }, "examples": { "default": { + "summary": "Example of content exclusion paths", "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 + "octo-repo": [ + "/src/some-dir/kernel.rs" ] } } @@ -189736,178 +188002,1876 @@ } }, "responses": { - "201": { - "description": "Response when creating a secret", + "200": { + "description": "Success", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", "type": "object", - "properties": {}, - "additionalProperties": false + "properties": { + "message": { + "type": "string" + } + } }, "examples": { "default": { - "value": null + "value": { + "message": "Content exclusion rules updated successfully." + } } } } } }, - "204": { - "description": "Response when updating a secret" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - }, - "delete": { - "summary": "Delete an organization secret", - "description": "Deletes a secret in an organization using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/delete-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { - "get": { - "summary": "List selected repositories for an organization secret", - "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/list-selected-repos-for-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - } - ], - "responses": { - "200": { - "description": "Response", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "repositories": { + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "413": { + "description": "Payload Too Large", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": null, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-content-exclusion-management" + } + } + }, + "/orgs/{org}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an organization", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 100 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, "properties": { - "id": { + "total_engaged_users": { "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in GitHub.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + }, + "examples": { + "default": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Copilot Usage Metrics API setting is disabled at the organization or enterprise level.", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/organization-1-day": { + "get": { + "summary": "Get Copilot organization usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + } + } + } + } + }, + "204": { + "description": "A header with no content is returned." + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest": { + "get": { + "summary": "Get Copilot organization usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/users-1-day": { + "get": { + "summary": "Get Copilot organization users usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-users-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + } + } + } + } + }, + "204": { + "description": "A header with no content is returned." + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/users-28-day/latest": { + "get": { + "summary": "Get Copilot organization users usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-users-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/credential-authorizations": { + "get": { + "summary": "List SAML SSO authorizations for an organization", + "description": "Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/enterprise-cloud@latest/articles/about-authentication-with-saml-single-sign-on).\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-saml-sso-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page token", + "in": "query", + "schema": { + "type": "integer" + } + }, + { + "name": "login", + "description": "Limits the list of credentials authorizations for an organization to a specific login", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Credential Authorization", + "description": "Credential Authorization", + "type": "object", + "properties": { + "login": { + "type": "string", + "description": "User login that owns the underlying credential.", + "examples": [ + "monalisa" + ] + }, + "credential_id": { + "type": "integer", + "description": "Unique identifier for the authorization of the credential. Use this to revoke authorization of the underlying token or key.", + "examples": [ + 1 + ] + }, + "credential_type": { + "type": "string", + "description": "Human-readable description of the credential type.", + "examples": [ + "SSH Key" + ] + }, + "token_last_eight": { + "type": "string", + "description": "Last eight characters of the credential. Only included in responses with credential_type of personal access token.", + "examples": [ + "12345678" + ] + }, + "credential_authorized_at": { + "type": "string", + "format": "date-time", + "description": "Date when the credential was authorized for use.", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "scopes": { + "type": "array", + "description": "List of oauth scopes the token has been granted.", + "items": { + "type": "string" + }, + "examples": [ + "user", + "repo" + ] + }, + "fingerprint": { + "type": "string", + "description": "Unique string to distinguish the credential. Only included in responses with credential_type of SSH Key.", + "examples": [ + "jklmnop12345678" + ] + }, + "credential_accessed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Date when the credential was last accessed. May be null if it was never accessed", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "authorized_credential_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the underlying token that was authorized by the user. This will remain unchanged across authorizations of the token.", + "examples": [ + 12345678 + ] + }, + "authorized_credential_title": { + "type": [ + "string", + "null" + ], + "description": "The title given to the ssh key. This will only be present when the credential is an ssh key.", + "examples": [ + "my ssh key" + ] + }, + "authorized_credential_note": { + "type": [ + "string", + "null" + ], + "description": "The note given to the token. This will only be present when the credential is a token.", + "examples": [ + "my token" + ] + }, + "authorized_credential_expires_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The expiry for the token. This will only be present when the credential is a token." + } + }, + "required": [ + "login", + "credential_id", + "credential_type", + "credential_authorized_at", + "credential_accessed_at", + "authorized_credential_id" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "login": "octocat", + "credential_id": 161195, + "credential_type": "personal access token", + "token_last_eight": "71c3fc11", + "credential_authorized_at": "2011-01-26T19:06:43Z", + "credential_accessed_at": "2011-01-26T19:06:43Z", + "authorized_credential_expires_at": "2011-02-25T19:06:43Z", + "scopes": [ + "user", + "repo" + ] + }, + { + "login": "hubot", + "credential_id": 161196, + "credential_type": "personal access token", + "token_last_eight": "Ae178B4a", + "credential_authorized_at": "2019-03-29T19:06:43Z", + "credential_accessed_at": "2011-01-26T19:06:43Z", + "authorized_credential_expires_at": "2019-04-28T19:06:43Z", + "scopes": [ + "repo" + ] + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/{credential_id}": { + "delete": { + "summary": "Remove a SAML SSO authorization for an organization", + "description": "Removes a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-saml-sso-authorization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "credential_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/custom-repository-roles": { + "get": { + "summary": "List custom repository roles in an organization", + "description": "List the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-custom-repo-roles", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response - list of custom role names", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of custom roles in this organization", + "type": "integer", + "examples": [ + 3 + ] + }, + "custom_roles": { + "type": "array", + "items": { + "title": "Organization Custom Repository Role", + "description": "Custom repository roles created by organization owners", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the custom role.", + "type": "integer" }, "name": { - "type": "string", - "examples": [ - "Hello-World" + "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", + "null" ] }, - "full_name": { + "base_role": { "type": "string", - "examples": [ - "octocat/Hello-World" + "description": "The system role from which this role inherits permissions.", + "enum": [ + "read", + "triage", + "write", + "maintain" ] }, - "owner": { + "permissions": { + "description": "A list of additional permissions included in this role.", + "type": "array", + "items": { + "type": "string" + } + }, + "organization": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -190075,827 +190039,99 @@ "url" ] }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { + "created_at": { "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] + "format": "date-time" }, - "git_tags_url": { + "updated_at": { "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] + "format": "date-time" + } + }, + "required": [ + "id", + "name", + "base_role", + "permissions", + "organization", + "created_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "custom_roles": [ + { + "id": 8030, + "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 }, - "git_url": { - "type": "string" + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:20:11Z" + }, + { + "id": 8031, + "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 }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_validity_checks": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_bypass": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - }, - "mode": { - "type": "string", - "description": "The bypass mode for the reviewer", - "enum": [ - "ALWAYS", - "EXEMPT" - ], - "default": "ALWAYS" - } - } - } - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 1, - "repositories": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + "created_at": "2022-07-05T12:01:11Z", + "updated_at": "2022-07-05T12:20:11Z" } ] } @@ -190906,22 +190142,22 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "orgs", + "subcategory": "custom-roles" } }, - "put": { - "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "post": { + "summary": "Create a custom repository role", + "description": "Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "orgs" ], - "operationId": "dependabot/set-selected-repos-for-org-secret", + "operationId": "orgs/create-custom-repo-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#create-a-custom-repository-role" }, "parameters": [ { @@ -190932,15 +190168,6 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { @@ -190950,23 +190177,49 @@ "schema": { "type": "object", "properties": { - "selected_repository_ids": { + "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", + "null" + ] + }, + "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", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { - "type": "integer" + "type": "string" } } }, "required": [ - "selected_repository_ids" + "name", + "base_role", + "permissions" ] }, "examples": { "default": { "value": { - "selected_repository_ids": [ - 64780797 + "name": "Labeler", + "description": "A role for issue and pull request labelers", + "base_role": "read", + "permissions": [ + "add_label" ] } } @@ -190975,579 +190228,260 @@ } }, "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { - "put": { - "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/add-selected-repo-to-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "No Content when repository was added to the selected list" - }, - "409": { - "description": "Conflict when visibility type is not set to selected" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - }, - "delete": { - "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/remove-selected-repo-from-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response when repository was removed from the selected list" - }, - "409": { - "description": "Conflict when visibility type not set to selected" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/dismissal-requests/code-scanning": { - "get": { - "summary": "List dismissal requests for code scanning alerts for an organization", - "description": "Lists dismissal requests for code scanning alerts for all repositories in an organization.\n\nThe user must be authorized to review dismissal requests for the organization.\nPersonal access tokens (classic) need the `security_events` scope to use this endpoint.", - "tags": [ - "code-scanning" - ], - "operationId": "code-scanning/list-org-dismissal-requests", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/alert-dismissal-requests#list-dismissal-requests-for-code-scanning-alerts-for-an-organization" - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "code-scanning", - "subcategory": "alert-dismissal-requests" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "reviewer", - "description": "Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "requester", - "description": "Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "time_period", - "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours).", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "hour", - "day", - "week", - "month" - ], - "default": "month" - } - }, - { - "name": "request_status", - "description": "Filter alert dismissal requests by status. When specified, only requests with this status will be returned.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "approved", - "expired", - "denied", - "all" - ], - "default": "all" - } - }, - { - "name": "repository_name", - "description": "The name of the repository to filter on.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "A list of alert dismissal requests.", + "201": { + "description": "Response", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Code scanning alert dismissal request", - "description": "Alert dismisal request made by a user asking to dismiss a code scanning alert.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the dismissal request." - }, - "number": { - "type": "integer", - "format": "int64", - "description": "The number uniquely identifying the dismissal request within its repository." - }, - "repository": { - "type": "object", - "description": "The repository the dismissal request is for.", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The ID of the repository the dismissal request is for." - }, - "name": { - "type": "string", - "description": "The name of the repository the dismissal request is for." - }, - "full_name": { - "type": "string", - "description": "The full name of the repository the dismissal request is for." - } - } - }, - "organization": { - "type": "object", - "description": "The organization associated with the repository the dismissal request is for.", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The ID of the organization." - }, - "name": { - "type": "string", - "description": "The name of the organization." - } - } - }, - "requester": { - "type": "object", - "description": "The user who requested the dismissal request.", - "properties": { - "actor_id": { - "type": "integer", - "format": "int64", - "description": "The ID of the GitHub user who requested the dismissal request." - }, - "actor_name": { - "type": "string", - "description": "The name of the GitHub user who requested the dismissal request." - } - } - }, - "request_type": { - "type": "string", - "description": "The type of request." - }, - "data": { - "type": [ - "array", - "null" - ], - "description": "Data describing the dismissal request metadata.", - "items": { - "type": "object", - "properties": { - "reason": { - "type": "string", - "description": "The reason for the dismissal request." - }, - "alert_number": { - "type": "string", - "description": "alert number." - }, - "pr_review_thread_id": { - "type": "string", - "description": "The ID of the pull request review thread." - } - } - } - }, - "resource_identifier": { - "type": "string", - "description": "The unique identifier for the request type of the dismissal request.", - "examples": [ - "827efc6d56897b048c772eb4087f854f46256132" - ] - }, - "status": { - "type": "string", - "description": "The status of the dismissal request.", - "enum": [ - "pending", - "denied", - "approved", - "expired" - ] - }, - "requester_comment": { - "type": [ - "string", - "null" - ], - "description": "The comment the requester provided when creating the dismissal request." - }, - "expires_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the dismissal request will expire." - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the dismissal request was created." - }, - "responses": { - "type": [ - "array", - "null" - ], - "description": "The responses to the dismissal request.", - "items": { - "title": "Dismissal request response", - "description": "A response made by a requester to dismiss the request.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The ID of the response to the dismissal request." - }, - "reviewer": { - "type": "object", - "description": "The user who reviewed the dismissal request.", - "properties": { - "actor_id": { - "type": "integer", - "format": "int64", - "description": "The ID of the GitHub user who reviewed the dismissal request." - }, - "actor_name": { - "type": "string", - "description": "The name of the GitHub user who reviewed the dismissal request." - } - } - }, - "message": { - "type": [ - "string", - "null" - ], - "description": "The response comment of the reviewer." - }, - "status": { - "type": "string", - "description": "The response status to the dismissal request until dismissed.", - "enum": [ - "approved", - "denied", - "dismissed" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the response to the dismissal request was created." - } - } - } - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octo-org/smile/dismissal-requests/code-scanning/1" - ] - }, - "html_url": { - "type": "string", - "description": "The URL to view the dismissal request in a browser.", - "format": "uri", - "examples": [ - "https://github.com/octo-org/smile/code-scanning/alerts/1" - ] + "title": "Organization Custom Repository Role", + "description": "Custom repository roles created by organization owners", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the custom role.", + "type": "integer" + }, + "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", + "null" + ] + }, + "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" } - } - } - }, - "examples": { - "default": { - "value": [ - { - "id": 21, - "number": 42, - "repository": { - "id": 1, - "name": "smile", - "full_name": "octo-org/smile" + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "organization": { - "id": 1, - "name": "octo-org" + "email": { + "type": [ + "string", + "null" + ] }, - "requester": { - "actor_id": 12, - "actor_name": "monalisa" + "login": { + "type": "string", + "examples": [ + "octocat" + ] }, - "request_type": "code_scanning_alert_dismissal", - "data": [ - { - "reason": "won't fix", - "alert_number": 1 - } - ], - "resource_identifier": "123/10", - "status": "denied", - "requester_comment": "Won't fix", - "expires_at": "2024-07-08T08:43:03Z", - "created_at": "2024-07-01T08:43:03Z", - "responses": [ - { - "id": 42, - "reviewer": { - "actor_id": 4, - "actor_name": "octocat" - }, - "status": "denied", - "created_at": "2024-07-02T08:43:04Z" - } - ], - "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/code-scanning/1", - "html_url": "https://github.com/octo-org/smile/code-scanning/alerts/1" - }, - { - "id": 12, - "number": 24, - "repository": { - "id": 1, - "name": "smile", - "full_name": "octo-org/smile" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] }, - "organization": { - "id": 1, - "name": "octo-org" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "requester": { - "actor_id": 12, - "actor_name": "monalisa" + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "request_type": "code_scanning_alert_dismissal", - "data": [ - { - "reason": "won't fix", - "alert_number": 2 - } - ], - "resource_identifier": "123/12", - "status": "denied", - "requester_comment": "Token is already revoked, I'll remove it later", - "expires_at": "2024-07-08T07:43:03Z", - "created_at": "2024-07-01T07:43:03Z", - "responses": [ - { - "id": 42, - "reviewer": { - "actor_id": 4, - "actor_name": "octocat" - }, - "status": "denied", - "created_at": "2024-07-02T08:43:04Z" - } - ], - "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/code-scanning/2", - "html_url": "https://github.com/octo-org/smile/code-scanning/alerts/2" - } - ] - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "url": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time" }, - "status": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time" } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + }, + "required": [ + "id", + "name", + "base_role", + "permissions", + "organization", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 8030, + "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": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:20:11Z" } } } @@ -191629,8 +190563,8 @@ } } }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -191655,26 +190589,26 @@ } } } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-roles" } } }, - "/orgs/{org}/dismissal-requests/dependabot": { + "/orgs/{org}/custom-repository-roles/{role_id}": { "get": { - "summary": "List dismissal requests for Dependabot alerts for an organization", - "description": "Lists dismissal requests for Dependabot alerts in an organization.\n\nDelegated alert dismissal must be enabled on repositories in the org and the user must be an org admin, security manager,\nor have the appropriate permission to access this endpoint.\nPersonal access tokens (classic) need the `security_events` scope to use this endpoint.", + "summary": "Get a custom repository role", + "description": "Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ - "dependabot" + "orgs" ], - "operationId": "dependabot/list-dismissal-requests-for-org", + "operationId": "orgs/get-custom-repo-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#list-dismissal-requests-for-dependabot-alerts-for-an-organization" - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "alert-dismissal-requests" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#get-a-custom-repository-role" }, "parameters": [ { @@ -191687,420 +190621,667 @@ } }, { - "name": "repository_name", - "description": "The name of the repository to filter on.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "reviewer", - "description": "Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "requester", - "description": "Filter bypass requests by the handle of the GitHub user who requested the bypass.", - "in": "query", - "required": false, + "name": "role_id", + "description": "The unique identifier of the role.", + "in": "path", + "required": true, "schema": { - "type": "string" + "type": "integer" } - }, - { - "name": "time_period", - "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours).", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "hour", - "day", - "week", - "month" - ], - "default": "day" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Organization Custom Repository Role", + "description": "Custom repository roles created by organization owners", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the custom role.", + "type": "integer" + }, + "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", + "null" + ] + }, + "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": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "name", + "base_role", + "permissions", + "organization", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 8030, + "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": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:20:11Z" + } + } + } + } } }, - { - "name": "request_status", - "description": "The status of the dismissal request to filter on. When specified, only requests with this status will be returned.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "completed", - "cancelled", - "approved", - "expired", - "denied", - "open", - "all" - ], - "default": "all" + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } } - }, + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-roles" + } + }, + "patch": { + "summary": "Update a custom repository role", + "description": "Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-custom-repo-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#update-a-custom-repository-role" + }, + "parameters": [ { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "string" } }, { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "role_id", + "description": "The unique identifier of the role.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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", + "null" + ] + }, + "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" + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "Labeler", + "description": "A role for issue and PR labelers", + "base_role": "read", + "permissions": [ + "add_label", + "remove_label" + ] + } + } + } + } + } + }, "responses": { "200": { - "description": "A list of alert dismissal requests.", + "description": "Response", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Dependabot alert dismissal request", - "description": "Alert dismissal request made by a user asking to dismiss a Dependabot alert.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the dismissal request." - }, - "number": { - "type": "integer", - "format": "int64", - "description": "The number uniquely identifying the dismissal request within its repository." - }, - "repository": { - "type": "object", - "description": "The repository the dismissal request is for.", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The ID of the repository the dismissal request is for." - }, - "name": { - "type": "string", - "description": "The name of the repository the dismissal request is for." - }, - "full_name": { - "type": "string", - "description": "The full name of the repository the dismissal request is for." - } - } - }, - "organization": { - "type": "object", - "description": "The organization associated with the repository the dismissal request is for.", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The ID of the organization." - }, - "name": { - "type": "string", - "description": "The name of the organization." - } - } - }, - "requester": { - "type": "object", - "description": "The user who requested the dismissal request.", - "properties": { - "actor_id": { - "type": "integer", - "format": "int64", - "description": "The ID of the GitHub user who requested the dismissal request." - }, - "actor_name": { - "type": "string", - "description": "The name of the GitHub user who requested the dismissal request." - } - } - }, - "request_type": { - "type": "string", - "description": "The type of request." - }, - "data": { - "type": [ - "array", - "null" - ], - "description": "Data describing the dismissal request metadata.", - "items": { - "type": "object", - "properties": { - "reason": { - "type": "string", - "description": "The reason for the dismissal request." - }, - "alert_number": { - "type": "string", - "description": "The alert number." - }, - "alert_title": { - "type": "string", - "description": "The title of the alert." - } - } - } - }, - "resource_identifier": { - "type": "string", - "description": "The unique identifier for the request type of the dismissal request.", - "examples": [ - "123" - ] - }, - "status": { - "type": "string", - "description": "The status of the dismissal request.", - "enum": [ - "pending", - "denied", - "approved", - "expired" - ] - }, - "requester_comment": { - "type": [ - "string", - "null" - ], - "description": "The comment the requester provided when creating the dismissal request." - }, - "expires_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the dismissal request will expire." - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the dismissal request was created." - }, - "responses": { - "type": [ - "array", - "null" - ], - "description": "The responses to the dismissal request.", - "items": { - "title": "Dismissal request response", - "description": "A response made by a requester to dismiss the request.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The ID of the response to the dismissal request." - }, - "reviewer": { - "type": "object", - "description": "The user who reviewed the dismissal request.", - "properties": { - "actor_id": { - "type": "integer", - "format": "int64", - "description": "The ID of the GitHub user who reviewed the dismissal request." - }, - "actor_name": { - "type": "string", - "description": "The name of the GitHub user who reviewed the dismissal request." - } - } - }, - "message": { - "type": [ - "string", - "null" - ], - "description": "The response comment of the reviewer." - }, - "status": { - "type": "string", - "description": "The response status to the dismissal request until dismissed.", - "enum": [ - "approved", - "denied", - "dismissed" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the response to the dismissal request was created." - } - } - } - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octo-org/smile/dismissal-requests/dependabot/1" - ] - }, - "html_url": { - "type": "string", - "description": "The URL to view the dismissal request in a browser.", - "format": "uri", - "examples": [ - "https://github.com/octo-org/smile/security/dependabot/1" - ] + "title": "Organization Custom Repository Role", + "description": "Custom repository roles created by organization owners", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the custom role.", + "type": "integer" + }, + "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", + "null" + ] + }, + "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" } - } - } - }, - "examples": { - "default": { - "value": [ - { - "id": 21, - "number": 42, - "repository": { - "id": 1, - "name": "smile", - "full_name": "octo-org/smile" + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "organization": { - "id": 1, - "name": "octo-org" + "email": { + "type": [ + "string", + "null" + ] }, - "requester": { - "actor_id": 12, - "actor_name": "monalisa" + "login": { + "type": "string", + "examples": [ + "octocat" + ] }, - "request_type": "dependabot_alert_dismissal", - "data": [ - { - "reason": "no_bandwidth", - "alert_number": "1", - "alert_title": "lodash - GHSA-1234-abcd-5678" - } - ], - "resource_identifier": "1", - "status": "denied", - "requester_comment": "No bandwidth to fix this right now", - "expires_at": "2024-07-08T08:43:03Z", - "created_at": "2024-07-01T08:43:03Z", - "responses": [ - { - "id": 42, - "reviewer": { - "actor_id": 4, - "actor_name": "octocat" - }, - "status": "denied", - "created_at": "2024-07-02T08:43:04Z" - } - ], - "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/dependabot/1", - "html_url": "https://github.com/octo-org/smile/security/dependabot/1" - }, - { - "id": 12, - "number": 24, - "repository": { - "id": 1, - "name": "smile", - "full_name": "octo-org/smile" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] }, - "organization": { - "id": 1, - "name": "octo-org" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "requester": { - "actor_id": 12, - "actor_name": "monalisa" + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "request_type": "dependabot_alert_dismissal", - "data": [ - { - "reason": "tolerable_risk", - "alert_number": "2", - "alert_title": "axios - GHSA-5678-efgh-9012" - } - ], - "resource_identifier": "2", - "status": "approved", - "requester_comment": "Risk is acceptable for this internal tool", - "expires_at": "2024-07-08T07:43:03Z", - "created_at": "2024-07-01T07:43:03Z", - "responses": [ - { - "id": 43, - "reviewer": { - "actor_id": 4, - "actor_name": "octocat" - }, - "status": "approved", - "created_at": "2024-07-02T08:43:04Z" - } - ], - "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/dependabot/2", - "html_url": "https://github.com/octo-org/smile/security/dependabot/2" - } - ] - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "url": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time" }, - "status": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "name", + "base_role", + "permissions", + "organization", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 8030, + "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": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:20:11Z" } } } } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -192108,19 +191289,64 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -192145,26 +191371,24 @@ } } } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-roles" } - } - }, - "/orgs/{org}/dismissal-requests/secret-scanning": { - "get": { - "summary": "List alert dismissal requests for secret scanning for an org", - "description": "Lists requests to dismiss secret scanning alerts in an org.\n\nDelegated alert dismissal must be enabled on repositories in the org and the user must be an org admin, security manager,\nor have the \"Review and manage secret scanning alert dismissal requests\" permission to access this endpoint.", + }, + "delete": { + "summary": "Delete a custom repository role", + "description": "Deletes 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. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "secret-scanning" + "orgs" ], - "operationId": "secret-scanning/list-org-dismissal-requests", + "operationId": "orgs/delete-custom-repo-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-an-org" - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "secret-scanning", - "subcategory": "alert-dismissal-requests" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#delete-a-custom-repository-role" }, "parameters": [ { @@ -192177,374 +191401,440 @@ } }, { - "name": "repository_name", - "description": "The name of the repository to filter on.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "reviewer", - "description": "Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.", - "in": "query", - "required": false, + "name": "role_id", + "description": "The unique identifier of the role.", + "in": "path", + "required": true, "schema": { - "type": "string" + "type": "integer" } - }, + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-roles" + } + } + }, + "/orgs/{org}/custom_roles": { + "post": { + "summary": "Closing down - Create a custom role", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[Create a custom repository role](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#create-a-custom-repository-role)\" endpoint instead.\n\nCreates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-custom-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---create-a-custom-role" + }, + "parameters": [ { - "name": "requester", - "description": "Filter bypass requests by the handle of the GitHub user who requested the bypass.", - "in": "query", - "required": false, + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { "type": "string" } - }, - { - "name": "time_period", - "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours).", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "hour", - "day", - "week", - "month" - ], - "default": "day" - } - }, - { - "name": "request_status", - "description": "The status of the dismissal request to filter on. When specified, only requests with this status will be returned.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "completed", - "cancelled", - "approved", - "expired", - "denied", - "open", - "all" - ], - "default": "all" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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", + "null" + ] + }, + "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" + } + } + }, + "required": [ + "name", + "base_role", + "permissions" + ] + }, + "examples": { + "default": { + "value": { + "name": "Labeler", + "description": "A role for issue and pull request labelers", + "base_role": "read", + "permissions": [ + "add_label" + ] + } + } + } + } + } + }, "responses": { - "200": { - "description": "A list of the alert dismissal requests.", + "201": { + "description": "Response", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Secret scanning alert dismissal request", - "description": "A dismissal request made by a user asking to close a secret scanning alert in this repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the dismissal request." + "title": "Organization Custom Repository Role", + "description": "Custom repository roles created by organization owners", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the custom role.", + "type": "integer" + }, + "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", + "null" + ] + }, + "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": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "number": { - "type": "integer", - "description": "The number uniquely identifying the dismissal request within its repository." + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "name", + "base_role", + "permissions", + "organization", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 8030, + "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": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" }, - "repository": { + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:20:11Z" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { "type": "object", - "description": "The repository the dismissal request is for.", + "required": [ + "code" + ], "properties": { - "id": { - "type": "integer", - "description": "The ID of the repository the dismissal request is for." + "resource": { + "type": "string" }, - "name": { - "type": "string", - "description": "The name of the repository the dismissal request is for." + "field": { + "type": "string" }, - "full_name": { - "type": "string", - "description": "The full name of the repository the dismissal request is for." - } - } - }, - "organization": { - "type": "object", - "description": "The organization associated with the repository the dismissal request is for.", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the organization." + "message": { + "type": "string" }, - "name": { - "type": "string", - "description": "The name of the organization." - } - } - }, - "requester": { - "type": "object", - "description": "The user who requested the dismissal.", - "properties": { - "actor_id": { - "type": "integer", - "description": "The ID of the GitHub user who requested the dismissal." + "code": { + "type": "string" }, - "actor_name": { - "type": "string", - "description": "The name of the GitHub user who requested the dismissal." - } - } - }, - "request_type": { - "type": "string", - "description": "The type of request." - }, - "data": { - "type": [ - "array", - "null" - ], - "description": "Data describing the secret alert that is being requested to be dismissed.", - "items": { - "type": "object", - "properties": { - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "alert_number": { - "type": "string", - "description": "The number of the secret scanning alert that was detected." - }, - "reason": { - "type": "string", - "description": "The reason the user provided for requesting the dismissal.", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - } - } - } - }, - "resource_identifier": { - "type": "string", - "description": "The number of the secret scanning alert that was detected.", - "examples": [ - 1234 - ] - }, - "status": { - "type": "string", - "description": "The status of the dismissal request.", - "enum": [ - "pending", - "denied", - "approved", - "cancelled", - "expired" - ] - }, - "requester_comment": { - "type": [ - "string", - "null" - ], - "description": "The comment the requester provided when creating the dismissal request." - }, - "expires_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the dismissal request will expire." - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the dismissal request was created." - }, - "responses": { - "type": [ - "array", - "null" - ], - "description": "The responses to the dismissal request.", - "items": { - "title": "Bypass response", - "description": "A response made by a delegated bypasser to a bypass request.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the response to the bypass request." - }, - "reviewer": { - "type": "object", - "description": "The user who reviewed the bypass request.", - "properties": { - "actor_id": { - "type": "integer", - "description": "The ID of the GitHub user who reviewed the bypass request." - }, - "actor_name": { - "type": "string", - "description": "The name of the GitHub user who reviewed the bypass request." + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" } } - }, - "status": { - "type": "string", - "description": "The response status to the bypass request until dismissed.", - "enum": [ - "approved", - "denied", - "dismissed" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the response to the bypass request was created." - } + ] } } - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/1" - ] - }, - "html_url": { - "type": "string", - "description": "The URL to view the dismissal request in a browser.", - "format": "uri", - "examples": [ - "https://github.com/octo-org/smile/security/secret-scanning/17" - ] } } } - }, - "examples": { - "default": { - "value": [ - { - "id": 21, - "number": 42, - "repository": { - "id": 1, - "name": "smile", - "full_name": "octo-org/smile" - }, - "organization": { - "id": 1, - "name": "octo-org" - }, - "requester": { - "actor_id": 12, - "actor_name": "monalisa" - }, - "request_type": "secret_scanning_closure", - "data": [ - { - "secret_type": "adafruit_io_key", - "alert_number": 17, - "reason": "false_positive" - } - ], - "resource_identifier": 17, - "status": "denied", - "requester_comment": "Test token used in the readme as an example", - "expires_at": "2024-07-08T08:43:03Z", - "created_at": "2024-07-01T08:43:03Z", - "responses": [ - { - "id": 42, - "reviewer": { - "actor_id": 4, - "actor_name": "octocat" - }, - "status": "denied", - "created_at": "2024-07-02T08:43:04Z" - } - ], - "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/21", - "html_url": "https://github.com/octo-org/smile/security/secret-scanning/17" - }, - { - "id": 22, - "number": 43, - "repository": { - "id": 1, - "name": "smile", - "full_name": "octo-org/smile" - }, - "organization": { - "id": 1, - "name": "octo-org" - }, - "requester": { - "actor_id": 12, - "actor_name": "monalisa" - }, - "request_type": "secret_scanning_closure", - "data": [ - { - "secret_type": "adafruit_io_key", - "alert_number": 19 - } - ], - "resource_identifier": 19, - "status": "denied", - "requester_comment": "Test token used in the readme as an example", - "expires_at": "2024-07-08T08:43:03Z", - "created_at": "2024-07-01T08:43:03Z", - "responses": [ - { - "id": 46, - "reviewer": { - "actor_id": 4, - "actor_name": "octocat" - }, - "status": "approved", - "created_at": "2024-07-02T08:43:04Z" - } - ], - "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/22", - "html_url": "https://github.com/octo-org/smile/security/secret-scanning/19" - } - ] - } } } } @@ -192574,35 +191864,314 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "removalDate": "2023-09-06", + "deprecationDate": "2023-03-06", + "category": "orgs", + "subcategory": "custom-roles" + }, + "deprecated": true + } + }, + "/orgs/{org}/custom_roles/{role_id}": { + "get": { + "summary": "Closing down - Get a custom role", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[Get a custom repository role](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#get-a-custom-repository-role)\" endpoint instead.\n\nGets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-custom-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---get-a-custom-role" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "403": { - "description": "Forbidden", + { + "name": "role_id", + "description": "The unique identifier of the role.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Organization Custom Repository Role", + "description": "Custom repository roles created by organization owners", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "description": "The unique identifier of the custom role.", + "type": "integer" }, - "documentation_url": { + "name": { + "description": "The name of the custom role.", "type": "string" }, - "url": { - "type": "string" + "description": { + "description": "A short description about who this role is for or what permissions it grants.", + "type": [ + "string", + "null" + ] }, - "status": { - "type": "string" + "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": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "name", + "base_role", + "permissions", + "organization", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 8030, + "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": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:20:11Z" } } } } } }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -192627,20 +192196,27 @@ } } } - } - } - }, - "/orgs/{org}/docker/conflicts": { - "get": { - "summary": "Get list of conflicting packages during Docker migration for organization", - "description": "Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "removalDate": "2022-09-06", + "deprecationDate": "2023-03-06", + "category": "orgs", + "subcategory": "custom-roles" + }, + "deprecated": true + }, + "patch": { + "summary": "Closing down - Update a custom role", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[Update a custom repository role](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#update-a-custom-repository-role)\" endpoint instead.\n\nUpdates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "packages" + "orgs" ], - "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", + "operationId": "orgs/update-custom-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---update-a-custom-role" }, "parameters": [ { @@ -192651,78 +192227,1233 @@ "schema": { "type": "string" } + }, + { + "name": "role_id", + "description": "The unique identifier of the role.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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", + "null" + ] + }, + "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" + } + } + } + }, + "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": { - "type": "array", - "items": { - "title": "Package", - "description": "A software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package.", - "type": "integer", - "examples": [ - 1 - ] + "title": "Organization Custom Repository Role", + "description": "Custom repository roles created by organization owners", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the custom role.", + "type": "integer" + }, + "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", + "null" + ] + }, + "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": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "name": { - "description": "The name of the package.", - "type": "string", - "examples": [ - "super-linter" - ] + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "name", + "base_role", + "permissions", + "organization", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 8030, + "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": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" }, - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:20:11Z" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" ], - "examples": [ - "docker" - ] - }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/packages/container/super-linter" - ] - }, - "html_url": { - "type": "string", - "examples": [ - "https://github.com/orgs/github/packages/container/package/super-linter" - ] - }, - "version_count": { - "description": "The number of versions of the package.", + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "removalDate": "2022-09-06", + "deprecationDate": "2023-03-06", + "category": "orgs", + "subcategory": "custom-roles" + }, + "deprecated": true + }, + "delete": { + "summary": "Closing down - Delete a custom role", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[Delete a custom repository role](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#delete-a-custom-repository-role)\" endpoint instead.\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. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-custom-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---delete-a-custom-role" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "role_id", + "description": "The unique identifier of the role.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "removalDate": "2022-09-06", + "deprecationDate": "2023-03-06", + "category": "orgs", + "subcategory": "custom-roles" + }, + "deprecated": true + } + }, + "/orgs/{org}/dependabot/alerts": { + "get": { + "summary": "List Dependabot alerts for an organization", + "description": "Lists Dependabot alerts for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/list-alerts-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "classification", + "in": "query", + "description": "A comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned.\n\nCan be: `malware`, `general`", + "schema": { + "type": "string" + } + }, + { + "name": "state", + "in": "query", + "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`", + "schema": { + "type": "string" + } + }, + { + "name": "severity", + "in": "query", + "description": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`", + "schema": { + "type": "string" + } + }, + { + "name": "ecosystem", + "in": "query", + "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`", + "schema": { + "type": "string" + } + }, + { + "name": "package", + "in": "query", + "description": "A comma-separated list of package names. If specified, only alerts for these packages will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentage", + "in": "query", + "description": "CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "artifact_registry_url", + "in": "query", + "description": "A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "artifact_registry", + "in": "query", + "description": "A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned.\n\nCan be: `jfrog-artifactory`", + "schema": { + "type": "string" + } + }, + { + "name": "has", + "in": "query", + "description": "Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple `has` filters can be passed to filter for alerts that have all of the values.", + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "patch", + "deployment" + ] + } + } + ] + } + }, + { + "name": "assignee", + "in": "query", + "description": "Filter alerts by assignees.\nProvide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users.\nUse `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.", + "schema": { + "type": "string" + } + }, + { + "name": "runtime_risk", + "in": "query", + "description": "A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned.\n\nCan be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement`", + "schema": { + "type": "string" + } + }, + { + "name": "scope", + "in": "query", + "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.", + "schema": { + "type": "string", + "enum": [ + "development", + "runtime" + ] + } + }, + { + "name": "sort", + "in": "query", + "description": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.", + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "epss_percentage" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "description": "A Dependabot alert.", + "properties": { + "number": { "type": "integer", - "examples": [ - 1 - ] + "description": "The security alert number.", + "readOnly": true }, - "visibility": { + "state": { "type": "string", + "description": "The state of the Dependabot alert.", + "readOnly": true, "enum": [ - "private", - "public" - ], - "examples": [ - "private" + "auto_dismissed", + "dismissed", + "fixed", + "open" ] }, - "owner": { + "dependency": { + "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true + }, + "scope": { + "type": [ + "string", + "null" + ], + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "enum": [ + "development", + "runtime", + null + ] + }, + "relationship": { + "type": [ + "string", + "null" + ], + "description": "The vulnerable dependency's relationship to your project.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.\n", + "readOnly": true, + "enum": [ + "unknown", + "direct", + "transitive", + "inconclusive", + null + ] + } + } + }, + "security_advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { + "type": "string", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true + }, + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true + }, + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + } + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "classification": { + "type": "string", + "description": "The classification of the advisory.", + "readOnly": true, + "enum": [ + "general", + "malware" + ] + }, + "cvss": { + "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, + "properties": { + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true + }, + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The full CVSS vector string for the advisory.", + "readOnly": true + } + }, + "required": [ + "score", + "vector_string" + ], + "additionalProperties": false + }, + "cvss_severities": { + "type": [ + "object", + "null" + ], + "properties": { + "cvss_v3": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The CVSS 3 vector string." + }, + "score": { + "type": [ + "number", + "null" + ], + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The CVSS 4 vector string." + }, + "score": { + "type": [ + "number", + "null" + ], + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + } + } + }, + "epss": { + "type": [ + "object", + "null" + ], + "readOnly": true, + "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", + "properties": { + "percentage": { + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "percentile": { + "type": "number", + "minimum": 0, + "maximum": 100 + } + } + }, + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } + }, + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + } + }, + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } + }, + "required": [ + "url" + ], + "additionalProperties": false + } + }, + "published_at": { + "type": "string", + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + }, + "required": [ + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" + ], + "additionalProperties": false + }, + "security_vulnerability": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_by": { "anyOf": [ { "type": "null" @@ -192897,1042 +193628,1253 @@ } ] }, - "repository": { - "anyOf": [ - { - "type": "null" + "dismissed_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason that the alert was dismissed.", + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment associated with the alert's dismissal.", + "maxLength": 280 + }, + "fixed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "auto_dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissal_request": { + "title": "Dependabot alert dismissal request", + "description": "Information about an active dismissal request for this Dependabot alert.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the dismissal request." }, - { - "title": "Minimal Repository", - "description": "Minimal Repository", + "status": { + "type": "string", + "description": "The current status of the dismissal request.", + "enum": [ + "pending", + "approved", + "rejected", + "cancelled" + ] + }, + "requester": { "type": "object", + "description": "The user who requested the dismissal.", "properties": { "id": { "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] + "description": "The unique identifier of the user." }, - "node_id": { + "login": { "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, + "description": "The login name of the user." + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time when the dismissal request was created." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The API URL to get more information about this dismissal request." + } + } + }, + "assignees": { + "type": "array", + "description": "The users assigned to this alert.", + "readOnly": true, + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { "type": [ "string", "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "email": { + "type": [ + "string", + "null" ] }, - "contents_url": { + "login": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "octocat" ] }, - "contributors_url": { - "type": "string", - "format": "uri", + "id": { + "type": "integer", + "format": "int64", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + 1 ] }, - "deployments_url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "MDQ6VXNlcjE=" ] }, - "downloads_url": { + "avatar_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "https://github.com/images/error/octocat_happy.gif" ] }, - "events_url": { - "type": "string", - "format": "uri", + "gravatar_id": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" + "41d064eb2195891e12d0413f63227ea7" ] }, - "forks_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "https://api.github.com/users/octocat" ] }, - "languages_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + "https://github.com/octocat" ] }, - "merges_url": { + "followers_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "https://api.github.com/users/octocat/followers" ] }, - "notifications_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "pulls_url": { + "gists_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "releases_url": { + "starred_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "https://api.github.com/users/octocat/subscriptions" ] }, - "subscribers_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "https://api.github.com/users/octocat/orgs" ] }, - "subscription_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + "https://api.github.com/users/octocat/repos" ] }, - "tags_url": { + "events_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "teams_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" + "https://api.github.com/users/octocat/received_events" ] }, - "hooks_url": { + "type": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" + "User" ] }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { + "site_admin": { "type": "boolean" }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "starred_at": { "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", "examples": [ - "2011-01-26T19:14:43Z" + "\"2020-07-09T00:17:55Z\"" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { + "user_view_type": { "type": "string", "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false + "public" ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_validity_checks": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_bypass": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - }, - "mode": { - "type": "string", - "description": "The bypass mode for the reviewer", - "enum": [ - "ALWAYS", - "EXEMPT" - ], - "default": "ALWAYS" - } - } - } - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true } }, "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", + "avatar_url", "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", "html_url", "id", "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", "url" ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" } }, "required": [ - "id", - "name", - "package_type", - "visibility", + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", "url", "html_url", - "version_count", "created_at", - "updated_at" - ] + "updated_at", + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at", + "repository" + ], + "additionalProperties": false } }, "examples": { "default": { "value": [ { - "id": 197, - "name": "hello_docker", - "package_type": "container", - "owner": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "number": 2, + "state": "dismissed", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-rf4j-j272-fj86", + "cve_id": "CVE-2018-6188", + "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", + "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 1.11.8, < 1.11.10", + "first_patched_version": { + "identifier": "1.11.10" + } + } + ], + "severity": "high", + "cvss": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, + "cwes": [ + { + "cwe_id": "CWE-200", + "name": "Exposure of Sensitive Information to an Unauthorized Actor" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-rf4j-j272-fj86" + }, + { + "type": "CVE", + "value": "CVE-2018-6188" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" + }, + { + "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" + }, + { + "url": "https://usn.ubuntu.com/3559-1/" + }, + { + "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" + }, + { + "url": "http://www.securitytracker.com/id/1040422" + } + ], + "published_at": "2018-10-03T21:13:54Z", + "updated_at": "2022-04-26T18:35:37Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + "url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2", + "html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2", + "created_at": "2022-06-15T07:43:03Z", + "updated_at": "2022-08-23T14:29:47Z", + "dismissed_at": "2022-08-23T14:29:47Z", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", "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", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", "site_admin": false }, - "version_count": 1, - "visibility": "private", - "url": "https://api.github.com/orgs/github/packages/container/hello_docker", - "created_at": "2020-05-19T22:19:11Z", - "updated_at": "2020-05-19T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" + "dismissed_reason": "tolerable_risk", + "dismissed_comment": "This alert is accurate but we use a sanitizer.", + "fixed_at": null, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "repository": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "owner": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "private": true, + "html_url": "https://github.com/octo-org/octo-repo", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}" + } }, { - "id": 198, - "name": "goodbye_docker", - "package_type": "container", - "owner": { - "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 + "number": 1, + "state": "open", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" }, - "version_count": 2, - "visibility": "private", - "url": "https://api.github.com/orgs/github/packages/container/goodbye_docker", - "created_at": "2020-05-20T22:19:11Z", - "updated_at": "2020-05-20T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/package/goodbye_docker" + "security_advisory": { + "ghsa_id": "GHSA-8f4m-hccc-8qph", + "cve_id": "CVE-2021-20191", + "summary": "Insertion of Sensitive Information into Log File in ansible", + "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.9.0, < 2.9.18", + "first_patched_version": { + "identifier": "2.9.18" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.10.0, < 2.10.7", + "first_patched_version": { + "identifier": "2.10.7" + } + } + ], + "severity": "medium", + "cvss": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, + "cwes": [ + { + "cwe_id": "CWE-532", + "name": "Insertion of Sensitive Information into Log File" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-8f4m-hccc-8qph" + }, + { + "type": "CVE", + "value": "CVE-2021-20191" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" + }, + { + "url": "https://access.redhat.com/security/cve/cve-2021-20191" + }, + { + "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" + } + ], + "published_at": "2021-06-01T17:38:00Z", + "updated_at": "2021-08-12T23:06:00Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + "url": "https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1", + "html_url": "https://github.com/octo-org/hello-world/security/dependabot/1", + "created_at": "2022-06-14T15:21:52Z", + "updated_at": "2022-06-14T15:21:52Z", + "dismissed_at": null, + "dismissed_by": null, + "dismissed_reason": null, + "dismissed_comment": null, + "fixed_at": null, + "assignees": [], + "repository": { + "id": 664700648, + "node_id": "MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=", + "name": "hello-world", + "full_name": "octo-org/hello-world", + "owner": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "private": true, + "html_url": "https://github.com/octo-org/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/hello-world", + "archive_url": "https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/hello-world/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/hello-world/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/hello-world/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/hello-world/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/hello-world/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/hello-world/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/hello-world/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/hello-world/downloads", + "events_url": "https://api.github.com/repos/octo-org/hello-world/events", + "forks_url": "https://api.github.com/repos/octo-org/hello-world/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/hello-world/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/hello-world/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/hello-world/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/hello-world/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/hello-world/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/hello-world/languages", + "merges_url": "https://api.github.com/repos/octo-org/hello-world/merges", + "milestones_url": "https://api.github.com/repos/octo-org/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/hello-world/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/hello-world/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/hello-world/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/hello-world/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/hello-world/subscription", + "tags_url": "https://api.github.com/repos/octo-org/hello-world/tags", + "teams_url": "https://api.github.com/repos/octo-org/hello-world/teams", + "trees_url": "https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}" + } } ] } @@ -193940,6 +194882,77 @@ } } }, + "304": { + "description": "Not modified" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, "403": { "description": "Forbidden", "content": { @@ -193966,8 +194979,8 @@ } } }, - "401": { - "description": "Requires authentication", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -193991,27 +195004,57 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "packages", - "subcategory": "packages" + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "alerts" } } }, - "/orgs/{org}/events": { + "/orgs/{org}/dependabot/repository-access": { "get": { - "summary": "List public organization events", - "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", + "summary": "Lists the repositories Dependabot can access in an organization", + "description": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.", "tags": [ - "activity" + "dependabot" ], - "operationId": "activity/list-public-org-events", + "operationId": "dependabot/repository-access-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" }, "parameters": [ { @@ -194024,21 +195067,26 @@ } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "page", "in": "query", + "description": "The page number of results to fetch.", + "required": false, "schema": { "type": "integer", - "default": 30 + "minimum": 1, + "default": 1 } }, { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "per_page", "in": "query", + "description": "Number of results per page.", + "required": false, "schema": { "type": "integer", - "default": 1 + "minimum": 1, + "maximum": 100, + "default": 30 } } ], @@ -194048,1015 +195096,6740 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Event", - "description": "Event", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": [ - "string", - "null" - ] - }, - "actor": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "name", - "url" - ] - }, - "org": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] - }, - "payload": { - "oneOf": [ + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", + "type": "object", + "properties": { + "default_level": { + "type": [ + "string", + "null" + ], + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal", + null + ], + "examples": [ + "internal" + ] + }, + "accessible_repositories": { + "type": "array", + "items": { + "anyOf": [ { - "title": "CreateEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "full_ref": { - "type": "string" - }, - "master_branch": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "full_ref", - "master_branch", - "pusher_type" - ] + "type": "null" }, { - "title": "DeleteEvent", + "title": "Simple Repository", + "description": "A GitHub repository.", "type": "object", "properties": { - "ref": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] }, - "ref_type": { - "type": "string" + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "full_ref": { - "type": "string" + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "full_ref", - "pusher_type" - ] - }, - { - "title": "DiscussionEvent", - "type": "object", - "properties": { - "action": { - "type": "string" + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] }, - "discussion": { - "title": "Discussion", - "description": "A Discussion in a repository.", + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { + "name": { "type": [ "string", "null" ] }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - }, - "answer_html_url": { + "email": { "type": [ "string", "null" ] }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + "login": { "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" + "examples": [ + "octocat" ] }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string" - }, "id": { - "type": "integer" - }, - "locked": { - "type": "boolean" + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" ] }, - "repository_url": { - "type": "string" - }, - "state": { + "avatar_url": { "type": "string", - "description": "The current state of the discussion.\n`converting` means that the discussion is being converted from an issue.\n`transferring` means that the discussion is being transferred from another repository.", - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" ] }, - "state_reason": { - "description": "The reason for the current state", + "gravatar_id": { "type": [ "string", "null" ], - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ], "examples": [ - "resolved" + "41d064eb2195891e12d0413f63227ea7" ] }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { + "url": { "type": "string", - "format": "date-time" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" ] }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64", - "examples": [ - 208045946 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDU6TGFiZWwyMDgwNDU5NDY=" - ] - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/labels/bug" - ] - }, - "name": { - "description": "The name of the label.", - "type": "string", - "examples": [ - "bug" - ] - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ], - "examples": [ - "Something isn't working" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string", - "examples": [ - "FFFFFF" - ] - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "examples": [ - true - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - }, - "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "state_reason", - "locked", - "comments", - "created_at", - "updated_at", - "active_lock_reason", - "body" - ] - } - }, - "required": [ - "action", - "discussion" - ] - }, - { - "title": "IssuesEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repositories/42/issues/1" + "https://github.com/octocat" ] }, - "repository_url": { + "followers_url": { "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "comments_url": { + "following_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "events_url": { + "gists_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "html_url": { + "starred_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer", + "subscriptions_url": { + "type": "string", + "format": "uri", "examples": [ - 42 + "https://api.github.com/users/octocat/subscriptions" ] }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", + "organizations_url": { "type": "string", + "format": "uri", "examples": [ - "open" + "https://api.github.com/users/octocat/orgs" ] }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], + "repos_url": { + "type": "string", + "format": "uri", "examples": [ - "not_planned" + "https://api.github.com/users/octocat/repos" ] }, - "title": { - "description": "Title of the issue", + "events_url": { "type": "string", "examples": [ - "Widget creation fails in Safari on OS X 10.8" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ], + "received_events_url": { + "type": "string", + "format": "uri", "examples": [ - "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + "https://api.github.com/users/octocat/received_events" ] }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "type": { + "type": "string", + "examples": [ + "User" ] }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", "examples": [ - "bug", - "registration" + "\"2020-07-09T00:17:55Z\"" ] }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } + ] + } + } + }, + "additionalProperties": false + }, + "examples": { + "default": { + "value": { + "default_level": "public", + "accessible_repositories": [ + { + "id": 123456, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", + "name": "example-repo", + "full_name": "octocat/example-repo", + "owner": { + "name": "octocat", + "email": "octo@github.com", + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", + "gravatar_id": 1, + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat/example-repo", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "starred_at": "\"2020-07-09T00:17:55Z\"", + "user_view_type": "default" + }, + "private": false, + "html_url": "https://github.com/octocat/example-repo", + "description": "This is an example repository.", + "fork": false, + "url": "https://api.github.com/repos/octocat/example-repo", + "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", + "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", + "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", + "events_url": "https://api.github.com/repos/octocat/example-repo/events", + "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", + "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", + "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", + "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", + "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", + "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", + "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + } + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" + } + }, + "patch": { + "summary": "Updates Dependabot's repository access list for an organization", + "description": "Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.\n\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/update-repository-access-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repository_ids_to_add": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to add." + }, + "repository_ids_to_remove": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to remove." + } + }, + "example": { + "repository_ids_to_add": [ + 123, + 456 + ], + "repository_ids_to_remove": [ + 789 + ] + } + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status." + }, + "add-example": { + "summary": "Add repositories", + "value": { + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, + "/orgs/{org}/dependabot/repository-access/default-level": { + "put": { + "summary": "Set the default repository access level for Dependabot", + "description": "Sets the default level of repository access Dependabot will have while performing an update. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.\n\nThis operation supports both server-to-server and user-to-server access.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/set-repository-access-default-level", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "examples": [ + "internal" + ] + } + }, + "required": [ + "default_level" + ] + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status.", + "value": { + "default_level": "public" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, + "/orgs/{org}/dependabot/secrets": { + "get": { + "summary": "List organization secrets", + "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/list-org-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-organization-secrets" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "title": "Dependabot Secret for an Organization", + "description": "Secrets for GitHub Dependabot for an organization.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" + ] + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 3, + "secrets": [ + { + "name": "MY_ARTIFACTORY_PASSWORD", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "private" + }, + { + "name": "NPM_TOKEN", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "GH_TOKEN", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/dependabot/secrets/public-key": { + "get": { + "summary": "Get an organization public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-an-organization-public-key" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "DependabotPublicKey", + "description": "The public key used for setting Dependabot Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "examples": [ + "1234567" + ] + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "examples": [ + "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + ] + } + }, + "required": [ + "key_id", + "key" + ] + }, + "examples": { + "default": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/dependabot/secrets/{secret_name}": { + "get": { + "summary": "Get an organization secret", + "description": "Gets a single organization secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/get-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Dependabot Secret for an Organization", + "description": "Secrets for GitHub Dependabot for an organization.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" + ] + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "NPM_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/create-or-update-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + }, + "visibility": { + "type": "string", + "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + }, + "required": [ + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Delete an organization secret", + "description": "Deletes a secret in an organization using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/delete-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#delete-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { + "get": { + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/list-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "has_pull_requests": { + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_validity_checks": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + }, + "mode": { + "type": "string", + "description": "The bypass mode for the reviewer", + "enum": [ + "ALWAYS", + "EXEMPT" + ], + "default": "ALWAYS" + } + } + } + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Set selected repositories for an organization secret", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/set-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization secret", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/add-selected-repo-to-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "No Content when repository was added to the selected list" + }, + "409": { + "description": "Conflict when visibility type is not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Remove selected repository from an organization secret", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/remove-selected-repo-from-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response when repository was removed from the selected list" + }, + "409": { + "description": "Conflict when visibility type not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/dismissal-requests/code-scanning": { + "get": { + "summary": "List dismissal requests for code scanning alerts for an organization", + "description": "Lists dismissal requests for code scanning alerts for all repositories in an organization.\n\nThe user must be authorized to review dismissal requests for the organization.\nPersonal access tokens (classic) need the `security_events` scope to use this endpoint.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/list-org-dismissal-requests", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/alert-dismissal-requests#list-dismissal-requests-for-code-scanning-alerts-for-an-organization" + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "code-scanning", + "subcategory": "alert-dismissal-requests" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "reviewer", + "description": "Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "requester", + "description": "Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "time_period", + "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "hour", + "day", + "week", + "month" + ], + "default": "month" + } + }, + { + "name": "request_status", + "description": "Filter alert dismissal requests by status. When specified, only requests with this status will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "approved", + "expired", + "denied", + "all" + ], + "default": "all" + } + }, + { + "name": "repository_name", + "description": "The name of the repository to filter on.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "A list of alert dismissal requests.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Code scanning alert dismissal request", + "description": "Alert dismisal request made by a user asking to dismiss a code scanning alert.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the dismissal request." + }, + "number": { + "type": "integer", + "format": "int64", + "description": "The number uniquely identifying the dismissal request within its repository." + }, + "repository": { + "type": "object", + "description": "The repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the repository the dismissal request is for." + }, + "name": { + "type": "string", + "description": "The name of the repository the dismissal request is for." + }, + "full_name": { + "type": "string", + "description": "The full name of the repository the dismissal request is for." + } + } + }, + "organization": { + "type": "object", + "description": "The organization associated with the repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the organization." + }, + "name": { + "type": "string", + "description": "The name of the organization." + } + } + }, + "requester": { + "type": "object", + "description": "The user who requested the dismissal request.", + "properties": { + "actor_id": { + "type": "integer", + "format": "int64", + "description": "The ID of the GitHub user who requested the dismissal request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who requested the dismissal request." + } + } + }, + "request_type": { + "type": "string", + "description": "The type of request." + }, + "data": { + "type": [ + "array", + "null" + ], + "description": "Data describing the dismissal request metadata.", + "items": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "The reason for the dismissal request." + }, + "alert_number": { + "type": "string", + "description": "alert number." + }, + "pr_review_thread_id": { + "type": "string", + "description": "The ID of the pull request review thread." + } + } + } + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the dismissal request.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "status": { + "type": "string", + "description": "The status of the dismissal request.", + "enum": [ + "pending", + "denied", + "approved", + "expired" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the dismissal request." + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the dismissal request.", + "items": { + "title": "Dismissal request response", + "description": "A response made by a requester to dismiss the request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the response to the dismissal request." + }, + "reviewer": { + "type": "object", + "description": "The user who reviewed the dismissal request.", + "properties": { + "actor_id": { + "type": "integer", + "format": "int64", + "description": "The ID of the GitHub user who reviewed the dismissal request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who reviewed the dismissal request." + } + } + }, + "message": { + "type": [ + "string", + "null" + ], + "description": "The response comment of the reviewer." + }, + "status": { + "type": "string", + "description": "The response status to the dismissal request until dismissed.", + "enum": [ + "approved", + "denied", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the response to the dismissal request was created." + } + } + } + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octo-org/smile/dismissal-requests/code-scanning/1" + ] + }, + "html_url": { + "type": "string", + "description": "The URL to view the dismissal request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/octo-org/smile/code-scanning/alerts/1" + ] + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "id": 21, + "number": 42, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "code_scanning_alert_dismissal", + "data": [ + { + "reason": "won't fix", + "alert_number": 1 + } + ], + "resource_identifier": "123/10", + "status": "denied", + "requester_comment": "Won't fix", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/code-scanning/1", + "html_url": "https://github.com/octo-org/smile/code-scanning/alerts/1" + }, + { + "id": 12, + "number": 24, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "code_scanning_alert_dismissal", + "data": [ + { + "reason": "won't fix", + "alert_number": 2 + } + ], + "resource_identifier": "123/12", + "status": "denied", + "requester_comment": "Token is already revoked, I'll remove it later", + "expires_at": "2024-07-08T07:43:03Z", + "created_at": "2024-07-01T07:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/code-scanning/2", + "html_url": "https://github.com/octo-org/smile/code-scanning/alerts/2" + } + ] + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "/orgs/{org}/dismissal-requests/dependabot": { + "get": { + "summary": "List dismissal requests for Dependabot alerts for an organization", + "description": "Lists dismissal requests for Dependabot alerts in an organization.\n\nDelegated alert dismissal must be enabled on repositories in the org and the user must be an org admin, security manager,\nor have the appropriate permission to access this endpoint.\nPersonal access tokens (classic) need the `security_events` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/list-dismissal-requests-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#list-dismissal-requests-for-dependabot-alerts-for-an-organization" + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "alert-dismissal-requests" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_name", + "description": "The name of the repository to filter on.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "reviewer", + "description": "Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "requester", + "description": "Filter bypass requests by the handle of the GitHub user who requested the bypass.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "time_period", + "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "hour", + "day", + "week", + "month" + ], + "default": "day" + } + }, + { + "name": "request_status", + "description": "The status of the dismissal request to filter on. When specified, only requests with this status will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "cancelled", + "approved", + "expired", + "denied", + "open", + "all" + ], + "default": "all" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "A list of alert dismissal requests.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Dependabot alert dismissal request", + "description": "Alert dismissal request made by a user asking to dismiss a Dependabot alert.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the dismissal request." + }, + "number": { + "type": "integer", + "format": "int64", + "description": "The number uniquely identifying the dismissal request within its repository." + }, + "repository": { + "type": "object", + "description": "The repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the repository the dismissal request is for." + }, + "name": { + "type": "string", + "description": "The name of the repository the dismissal request is for." + }, + "full_name": { + "type": "string", + "description": "The full name of the repository the dismissal request is for." + } + } + }, + "organization": { + "type": "object", + "description": "The organization associated with the repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the organization." + }, + "name": { + "type": "string", + "description": "The name of the organization." + } + } + }, + "requester": { + "type": "object", + "description": "The user who requested the dismissal request.", + "properties": { + "actor_id": { + "type": "integer", + "format": "int64", + "description": "The ID of the GitHub user who requested the dismissal request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who requested the dismissal request." + } + } + }, + "request_type": { + "type": "string", + "description": "The type of request." + }, + "data": { + "type": [ + "array", + "null" + ], + "description": "Data describing the dismissal request metadata.", + "items": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "The reason for the dismissal request." + }, + "alert_number": { + "type": "string", + "description": "The alert number." + }, + "alert_title": { + "type": "string", + "description": "The title of the alert." + } + } + } + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the dismissal request.", + "examples": [ + "123" + ] + }, + "status": { + "type": "string", + "description": "The status of the dismissal request.", + "enum": [ + "pending", + "denied", + "approved", + "expired" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the dismissal request." + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the dismissal request.", + "items": { + "title": "Dismissal request response", + "description": "A response made by a requester to dismiss the request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the response to the dismissal request." + }, + "reviewer": { + "type": "object", + "description": "The user who reviewed the dismissal request.", + "properties": { + "actor_id": { + "type": "integer", + "format": "int64", + "description": "The ID of the GitHub user who reviewed the dismissal request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who reviewed the dismissal request." + } + } + }, + "message": { + "type": [ + "string", + "null" + ], + "description": "The response comment of the reviewer." + }, + "status": { + "type": "string", + "description": "The response status to the dismissal request until dismissed.", + "enum": [ + "approved", + "denied", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the response to the dismissal request was created." + } + } + } + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octo-org/smile/dismissal-requests/dependabot/1" + ] + }, + "html_url": { + "type": "string", + "description": "The URL to view the dismissal request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/octo-org/smile/security/dependabot/1" + ] + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "id": 21, + "number": 42, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "dependabot_alert_dismissal", + "data": [ + { + "reason": "no_bandwidth", + "alert_number": "1", + "alert_title": "lodash - GHSA-1234-abcd-5678" + } + ], + "resource_identifier": "1", + "status": "denied", + "requester_comment": "No bandwidth to fix this right now", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/dependabot/1", + "html_url": "https://github.com/octo-org/smile/security/dependabot/1" + }, + { + "id": 12, + "number": 24, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "dependabot_alert_dismissal", + "data": [ + { + "reason": "tolerable_risk", + "alert_number": "2", + "alert_title": "axios - GHSA-5678-efgh-9012" + } + ], + "resource_identifier": "2", + "status": "approved", + "requester_comment": "Risk is acceptable for this internal tool", + "expires_at": "2024-07-08T07:43:03Z", + "created_at": "2024-07-01T07:43:03Z", + "responses": [ + { + "id": 43, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "approved", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/dependabot/2", + "html_url": "https://github.com/octo-org/smile/security/dependabot/2" + } + ] + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "/orgs/{org}/dismissal-requests/secret-scanning": { + "get": { + "summary": "List alert dismissal requests for secret scanning for an org", + "description": "Lists requests to dismiss secret scanning alerts in an org.\n\nDelegated alert dismissal must be enabled on repositories in the org and the user must be an org admin, security manager,\nor have the \"Review and manage secret scanning alert dismissal requests\" permission to access this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-org-dismissal-requests", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-an-org" + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "alert-dismissal-requests" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_name", + "description": "The name of the repository to filter on.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "reviewer", + "description": "Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "requester", + "description": "Filter bypass requests by the handle of the GitHub user who requested the bypass.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "time_period", + "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "hour", + "day", + "week", + "month" + ], + "default": "day" + } + }, + { + "name": "request_status", + "description": "The status of the dismissal request to filter on. When specified, only requests with this status will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "cancelled", + "approved", + "expired", + "denied", + "open", + "all" + ], + "default": "all" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "A list of the alert dismissal requests.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Secret scanning alert dismissal request", + "description": "A dismissal request made by a user asking to close a secret scanning alert in this repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the dismissal request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the dismissal request within its repository." + }, + "repository": { + "type": "object", + "description": "The repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the repository the dismissal request is for." + }, + "name": { + "type": "string", + "description": "The name of the repository the dismissal request is for." + }, + "full_name": { + "type": "string", + "description": "The full name of the repository the dismissal request is for." + } + } + }, + "organization": { + "type": "object", + "description": "The organization associated with the repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the organization." + }, + "name": { + "type": "string", + "description": "The name of the organization." + } + } + }, + "requester": { + "type": "object", + "description": "The user who requested the dismissal.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who requested the dismissal." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who requested the dismissal." + } + } + }, + "request_type": { + "type": "string", + "description": "The type of request." + }, + "data": { + "type": [ + "array", + "null" + ], + "description": "Data describing the secret alert that is being requested to be dismissed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "alert_number": { + "type": "string", + "description": "The number of the secret scanning alert that was detected." + }, + "reason": { + "type": "string", + "description": "The reason the user provided for requesting the dismissal.", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + } + } + } + }, + "resource_identifier": { + "type": "string", + "description": "The number of the secret scanning alert that was detected.", + "examples": [ + 1234 + ] + }, + "status": { + "type": "string", + "description": "The status of the dismissal request.", + "enum": [ + "pending", + "denied", + "approved", + "cancelled", + "expired" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the dismissal request." + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the dismissal request.", + "items": { + "title": "Bypass response", + "description": "A response made by a delegated bypasser to a bypass request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the response to the bypass request." + }, + "reviewer": { + "type": "object", + "description": "The user who reviewed the bypass request.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who reviewed the bypass request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who reviewed the bypass request." + } + } + }, + "status": { + "type": "string", + "description": "The response status to the bypass request until dismissed.", + "enum": [ + "approved", + "denied", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the response to the bypass request was created." + } + } + } + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/1" + ] + }, + "html_url": { + "type": "string", + "description": "The URL to view the dismissal request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/octo-org/smile/security/secret-scanning/17" + ] + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "id": 21, + "number": 42, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning_closure", + "data": [ + { + "secret_type": "adafruit_io_key", + "alert_number": 17, + "reason": "false_positive" + } + ], + "resource_identifier": 17, + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/21", + "html_url": "https://github.com/octo-org/smile/security/secret-scanning/17" + }, + { + "id": 22, + "number": 43, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning_closure", + "data": [ + { + "secret_type": "adafruit_io_key", + "alert_number": 19 + } + ], + "resource_identifier": 19, + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 46, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "approved", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/22", + "html_url": "https://github.com/octo-org/smile/security/secret-scanning/19" + } + ] + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "/orgs/{org}/docker/conflicts": { + "get": { + "summary": "Get list of conflicting packages during Docker migration for organization", + "description": "Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", + "tags": [ + "packages" + ], + "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Package", + "description": "A software package", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the package.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the package.", + "type": "string", + "examples": [ + "super-linter" + ] + }, + "package_type": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ], + "examples": [ + "docker" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/packages/container/super-linter" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "https://github.com/orgs/github/packages/container/package/super-linter" + ] + }, + "version_count": { + "description": "The number of versions of the package.", + "type": "integer", + "examples": [ + 1 + ] + }, + "visibility": { + "type": "string", + "enum": [ + "private", + "public" + ], + "examples": [ + "private" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "repository": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "has_pull_requests": { + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_validity_checks": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + }, + "mode": { + "type": "string", + "description": "The bypass mode for the reviewer", + "enum": [ + "ALWAYS", + "EXEMPT" + ], + "default": "ALWAYS" + } + } + } + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "name", + "package_type", + "visibility", + "url", + "html_url", + "version_count", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 197, + "name": "hello_docker", + "package_type": "container", + "owner": { + "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 + }, + "version_count": 1, + "visibility": "private", + "url": "https://api.github.com/orgs/github/packages/container/hello_docker", + "created_at": "2020-05-19T22:19:11Z", + "updated_at": "2020-05-19T22:19:11Z", + "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" + }, + { + "id": 198, + "name": "goodbye_docker", + "package_type": "container", + "owner": { + "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 + }, + "version_count": 2, + "visibility": "private", + "url": "https://api.github.com/orgs/github/packages/container/goodbye_docker", + "created_at": "2020-05-20T22:19:11Z", + "updated_at": "2020-05-20T22:19:11Z", + "html_url": "https://github.com/orgs/github/packages/container/package/goodbye_docker" + } + ] + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/orgs/{org}/events": { + "get": { + "summary": "List public organization events", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", + "tags": [ + "activity" + ], + "operationId": "activity/list-public-org-events", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-organization-events" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Event", + "description": "Event", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": [ + "string", + "null" + ] + }, + "actor": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "name", + "url" + ] + }, + "org": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] + }, + "payload": { + "oneOf": [ + { + "title": "CreateEvent", + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "ref_type": { + "type": "string" + }, + "full_ref": { + "type": "string" + }, + "master_branch": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "pusher_type": { + "type": "string" + } + }, + "required": [ + "ref", + "ref_type", + "full_ref", + "master_branch", + "pusher_type" + ] + }, + { + "title": "DeleteEvent", + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "ref_type": { + "type": "string" + }, + "full_ref": { + "type": "string" + }, + "pusher_type": { + "type": "string" + } + }, + "required": [ + "ref", + "ref_type", + "full_ref", + "pusher_type" + ] + }, + { + "title": "DiscussionEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "discussion": { + "title": "Discussion", + "description": "A Discussion in a repository.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "answer_html_url": { + "type": [ + "string", + "null" + ] + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "type": "string" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "description": "The current state of the discussion.\n`converting` means that the discussion is being converted from an issue.\n`transferring` means that the discussion is being transferred from another repository.", + "enum": [ + "open", + "closed", + "locked", + "converting", + "transferring" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "outdated", + "duplicate", + "reopened", + null + ], + "examples": [ + "resolved" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "examples": [ + 208045946 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDU6TGFiZWwyMDgwNDU5NDY=" + ] + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/labels/bug" + ] + }, + "name": { + "description": "The name of the label.", + "type": "string", + "examples": [ + "bug" + ] + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": [ + "string", + "null" + ], + "examples": [ + "Something isn't working" + ] + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string", + "examples": [ + "FFFFFF" + ] + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "state_reason", + "locked", + "comments", + "created_at", + "updated_at", + "active_lock_reason", + "body" + ] + } + }, + "required": [ + "action", + "discussion" + ] + }, + { + "title": "IssuesEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, "email": { "type": [ @@ -207027,14 +213800,14 @@ "/orgs/{org}/external-group/{group_id}": { "get": { "summary": "Get an external group", - "description": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "description": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/external-idp-group-info-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/external-groups#get-an-external-group" }, "parameters": [ { @@ -207057,7 +213830,7 @@ }, { "name": "per_page", - "description": "The number of results per page for the \"members\" array (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page for the \"members\" array (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -207066,7 +213839,7 @@ }, { "name": "page", - "description": "The page number of the \"members\" array results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the \"members\" array results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -207255,14 +214028,14 @@ "/orgs/{org}/external-groups": { "get": { "summary": "List external groups available to an organization", - "description": "Lists external groups provisioned on the enterprise that are available to an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Cloud generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see \"[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89).\"\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "description": "Lists external groups provisioned on the enterprise that are available to an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Cloud generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see \"[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89).\"\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/list-external-idp-groups-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-external-groups-available-to-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/external-groups#list-external-groups-available-to-an-organization" }, "parameters": [ { @@ -207276,7 +214049,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -207400,14 +214173,14 @@ "/orgs/{org}/failed_invitations": { "get": { "summary": "List failed organization invitations", - "description": "The return hash contains `failed_at` and `failed_reason` fields which\nrepresent the time at which the invitation failed and the reason for the failure.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).", + "description": "The return hash contains `failed_at` and `failed_reason` fields which\nrepresent the time at which the invitation failed and the reason for the failure.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).", "tags": [ "orgs" ], "operationId": "orgs/list-failed-invitations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-failed-organization-invitations" }, "parameters": [ { @@ -207421,7 +214194,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -207430,7 +214203,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -207775,14 +214548,14 @@ "/orgs/{org}/fine_grained_permissions": { "get": { "summary": "Closing down - List fine-grained permissions for an organization", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[List fine-grained repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)\" endpoint instead.\n\nLists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nTo use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[List fine-grained repository permissions](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)\" endpoint instead.\n\nLists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nTo use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-fine-grained-permissions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-fine-grained-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---list-fine-grained-permissions-for-an-organization" }, "parameters": [ { @@ -207863,7 +214636,7 @@ "operationId": "orgs/list-webhooks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#list-organization-webhooks" }, "parameters": [ { @@ -207877,7 +214650,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -207886,7 +214659,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -208095,7 +214868,7 @@ "operationId": "orgs/create-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#create-an-organization-webhook" }, "parameters": [ { @@ -208140,7 +214913,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -208178,7 +214951,7 @@ }, "events": { "type": "array", - "description": "Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.", + "description": "Determines what [events](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.", "default": [ "push" ], @@ -208489,7 +215262,7 @@ "operationId": "orgs/get-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#get-an-organization-webhook" }, "parameters": [ { @@ -208699,7 +215472,7 @@ "operationId": "orgs/update-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#update-an-organization-webhook" }, "parameters": [ { @@ -208749,7 +215522,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -208775,7 +215548,7 @@ }, "events": { "type": "array", - "description": "Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) the hook is triggered for.", + "description": "Determines what [events](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads) the hook is triggered for.", "default": [ "push" ], @@ -209071,7 +215844,7 @@ "operationId": "orgs/delete-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#delete-an-organization-webhook" }, "parameters": [ { @@ -209142,7 +215915,7 @@ "operationId": "orgs/get-webhook-config-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization" }, "parameters": [ { @@ -209191,7 +215964,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -209242,7 +216015,7 @@ "operationId": "orgs/update-webhook-config-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization" }, "parameters": [ { @@ -209288,7 +216061,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -209350,7 +216123,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -209403,7 +216176,7 @@ "operationId": "orgs/list-webhook-deliveries", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook" }, "parameters": [ { @@ -209426,7 +216199,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -209784,7 +216557,7 @@ "operationId": "orgs/get-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook" }, "parameters": [ { @@ -210209,7 +216982,7 @@ "operationId": "orgs/redeliver-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook" }, "parameters": [ { @@ -210417,7 +217190,7 @@ "operationId": "orgs/ping-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#ping-an-organization-webhook" }, "parameters": [ { @@ -210488,7 +217261,7 @@ "operationId": "api-insights/get-route-stats-by-actor", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-route-stats-by-actor" }, "parameters": [ { @@ -210545,7 +217318,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -210554,7 +217327,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -210683,7 +217456,7 @@ "operationId": "api-insights/get-subject-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-subject-stats" }, "parameters": [ { @@ -210715,7 +217488,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -210724,7 +217497,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -210851,7 +217624,7 @@ "operationId": "api-insights/get-summary-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-summary-stats" }, "parameters": [ { @@ -210933,7 +217706,7 @@ "operationId": "api-insights/get-summary-stats-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-summary-stats-by-user" }, "parameters": [ { @@ -211024,7 +217797,7 @@ "operationId": "api-insights/get-summary-stats-by-actor", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-summary-stats-by-actor" }, "parameters": [ { @@ -211131,7 +217904,7 @@ "operationId": "api-insights/get-time-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-time-stats" }, "parameters": [ { @@ -211254,7 +218027,7 @@ "operationId": "api-insights/get-time-stats-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-time-stats-by-user" }, "parameters": [ { @@ -211386,7 +218159,7 @@ "operationId": "api-insights/get-time-stats-by-actor", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-time-stats-by-actor" }, "parameters": [ { @@ -211534,7 +218307,7 @@ "operationId": "api-insights/get-user-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-user-stats" }, "parameters": [ { @@ -211575,7 +218348,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -211584,7 +218357,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -211719,14 +218492,14 @@ "/orgs/{org}/installation": { "get": { "summary": "Get an organization installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-org-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-organization-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app" }, "parameters": [ { @@ -212352,7 +219125,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -212867,7 +219640,7 @@ "operationId": "orgs/list-app-installations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-app-installations-for-an-organization" }, "parameters": [ { @@ -212881,7 +219654,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -212890,7 +219663,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -213523,7 +220296,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -214054,7 +220827,7 @@ "operationId": "interactions/get-restrictions-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/interactions/orgs#get-interaction-restrictions-for-an-organization" }, "parameters": [ { @@ -214147,7 +220920,7 @@ "operationId": "interactions/set-restrictions-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/interactions/orgs#set-interaction-restrictions-for-an-organization" }, "parameters": [ { @@ -214357,7 +221130,7 @@ "operationId": "interactions/remove-restrictions-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization" }, "parameters": [ { @@ -214386,14 +221159,14 @@ "/orgs/{org}/invitations": { "get": { "summary": "List pending organization invitations", - "description": "The return hash contains a `role` field which refers to the Organization\nInvitation role and will be one of the following values: `direct_member`, `admin`,\n`billing_manager`, or `hiring_manager`. If the invitee is not a GitHub Enterprise Cloud\nmember, the `login` field in the return hash will be `null`.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).", + "description": "The return hash contains a `role` field which refers to the Organization\nInvitation role and will be one of the following values: `direct_member`, `admin`,\n`billing_manager`, or `hiring_manager`. If the invitee is not a GitHub Enterprise Cloud\nmember, the `login` field in the return hash will be `null`.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).", "tags": [ "orgs" ], "operationId": "orgs/list-pending-invitations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-pending-organization-invitations" }, "parameters": [ { @@ -214407,7 +221180,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -214416,7 +221189,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -214791,14 +221564,14 @@ }, "post": { "summary": "Create an organization invitation", - "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-cloud@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "tags": [ "orgs" ], "operationId": "orgs/create-invitation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#create-an-organization-invitation" }, "parameters": [ { @@ -215259,14 +222032,14 @@ "/orgs/{org}/invitations/{invitation_id}": { "delete": { "summary": "Cancel an organization invitation", - "description": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications).", + "description": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications).", "tags": [ "orgs" ], "operationId": "orgs/cancel-invitation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#cancel-an-organization-invitation" }, "parameters": [ { @@ -215406,14 +222179,14 @@ "/orgs/{org}/invitations/{invitation_id}/teams": { "get": { "summary": "List organization invitation teams", - "description": "List all teams associated with an invitation. In order to see invitations\nin an organization, the authenticated user must be an organization owner.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).", + "description": "List all teams associated with an invitation. In order to see invitations\nin an organization, the authenticated user must be an organization owner.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).", "tags": [ "orgs" ], "operationId": "orgs/list-invitation-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-organization-invitation-teams" }, "parameters": [ { @@ -215436,7 +222209,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -215445,7 +222218,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -215794,7 +222567,7 @@ "operationId": "orgs/list-issue-fields", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-fields#list-issue-fields-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-fields#list-issue-fields-for-an-organization" }, "parameters": [ { @@ -216024,14 +222797,14 @@ }, "post": { "summary": "Create issue field for an organization", - "description": "Creates a new issue field for an organization.\n\nYou can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-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.", + "description": "Creates a new issue field for an organization.\n\nYou can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-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" ], "operationId": "orgs/create-issue-field", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-fields#create-issue-field-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-fields#create-issue-field-for-an-organization" }, "parameters": [ { @@ -216408,14 +223181,14 @@ "/orgs/{org}/issue-fields/{issue_field_id}": { "patch": { "summary": "Update issue field for an organization", - "description": "Updates an issue field for an organization.\n\nYou can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-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.", + "description": "Updates an issue field for an organization.\n\nYou can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-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" ], "operationId": "orgs/update-issue-field", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-fields#update-issue-field-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-fields#update-issue-field-for-an-organization" }, "parameters": [ { @@ -216805,14 +223578,14 @@ }, "delete": { "summary": "Delete issue field for an organization", - "description": "Deletes an issue field for an organization.\n\nYou can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-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.", + "description": "Deletes an issue field for an organization.\n\nYou can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-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" ], "operationId": "orgs/delete-issue-field", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-fields#delete-issue-field-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-fields#delete-issue-field-for-an-organization" }, "parameters": [ { @@ -216913,7 +223686,7 @@ "operationId": "orgs/list-issue-types", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#list-issue-types-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-types#list-issue-types-for-an-organization" }, "parameters": [ { @@ -217062,14 +223835,14 @@ }, "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).\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.", + "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" ], "operationId": "orgs/create-issue-type", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#create-issue-type-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-types#create-issue-type-for-an-organization" }, "parameters": [ { @@ -217296,14 +224069,14 @@ "/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).\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.", + "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" ], "operationId": "orgs/update-issue-type", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#update-issue-type-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-types#update-issue-type-for-an-organization" }, "parameters": [ { @@ -217537,14 +224310,14 @@ }, "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).\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.", + "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" ], "operationId": "orgs/delete-issue-type", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#delete-issue-type-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-types#delete-issue-type-for-an-organization" }, "parameters": [ { @@ -217638,14 +224411,14 @@ "/orgs/{org}/issues": { "get": { "summary": "List organization issues assigned to the authenticated user", - "description": "List issues in an organization assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues in an organization assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user" }, "parameters": [ { @@ -217749,7 +224522,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -217758,7 +224531,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -221957,7 +228730,7 @@ "operationId": "orgs/list-members", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-organization-members" }, "parameters": [ { @@ -221971,7 +228744,7 @@ }, { "name": "filter", - "description": "Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners.", + "description": "Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners.", "in": "query", "required": false, "schema": { @@ -222001,7 +228774,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -222010,7 +228783,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -222325,7 +229098,7 @@ "operationId": "orgs/check-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#check-organization-membership-for-a-user" }, "parameters": [ { @@ -222382,7 +229155,7 @@ "operationId": "orgs/remove-member", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#remove-an-organization-member" }, "parameters": [ { @@ -222453,12 +229226,12 @@ "operationId": "codespaces/get-codespaces-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#list-codespaces-for-a-user-in-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#list-codespaces-for-a-user-in-organization" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -222467,7 +229240,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -224745,7 +231518,7 @@ "operationId": "codespaces/delete-from-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#delete-a-codespace-from-the-organization" }, "parameters": [ { @@ -224918,7 +231691,7 @@ "operationId": "codespaces/stop-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#stop-a-codespace-for-an-organization-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user" }, "parameters": [ { @@ -226892,14 +233665,14 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data).\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/reference/metrics-data).\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/get-copilot-seat-details-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user" }, "parameters": [ { @@ -227796,7 +234569,7 @@ "operationId": "orgs/get-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#get-organization-membership-for-a-user" }, "parameters": [ { @@ -228294,14 +235067,14 @@ }, "put": { "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], "operationId": "orgs/set-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#set-organization-membership-for-a-user" }, "parameters": [ { @@ -228884,7 +235657,7 @@ "operationId": "orgs/remove-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#remove-organization-membership-for-a-user" }, "parameters": [ { @@ -228981,7 +235754,7 @@ "operationId": "migrations/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#list-organization-migrations" }, "parameters": [ { @@ -228995,7 +235768,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -229004,7 +235777,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -230481,7 +237254,7 @@ "operationId": "migrations/start-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#start-an-organization-migration" }, "parameters": [ { @@ -232127,7 +238900,7 @@ "operationId": "migrations/get-status-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#get-an-organization-migration-status" }, "parameters": [ { @@ -233633,7 +240406,7 @@ "operationId": "migrations/download-archive-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#download-an-organization-migration-archive" }, "parameters": [ { @@ -233702,7 +240475,7 @@ "operationId": "migrations/delete-archive-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#delete-an-organization-migration-archive" }, "parameters": [ { @@ -233766,14 +240539,14 @@ "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { "delete": { "summary": "Unlock an organization repository", - "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.", + "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.", "tags": [ "migrations" ], "operationId": "migrations/unlock-repo-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#unlock-an-organization-repository" }, "parameters": [ { @@ -233853,7 +240626,7 @@ "operationId": "migrations/list-repos-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#list-repositories-in-an-organization-migration" }, "parameters": [ { @@ -233876,7 +240649,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -233885,7 +240658,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -235020,14 +241793,14 @@ "/orgs/{org}/organization-fine-grained-permissions": { "get": { "summary": "List organization fine-grained permissions for an organization", - "description": "Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo list the fine-grained permissions that can be used in custom repository roles for an organization, see \"[List repository fine-grained permissions for an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo list the fine-grained permissions that can be used in custom repository roles for an organization, see \"[List repository fine-grained permissions for an organization](https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-organization-fine-grained-permissions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization" }, "parameters": [ { @@ -235195,14 +241968,14 @@ "/orgs/{org}/organization-roles": { "get": { "summary": "Get all organization roles for an organization", - "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-org-roles", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-all-organization-roles-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization" }, "parameters": [ { @@ -235670,14 +242443,14 @@ }, "post": { "summary": "Create a custom organization role", - "description": "Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo include repository permissions in an organization role, you must also include the `base_role`\nfield, which is one of `read`, `write`, `triage`, `maintain`, or `admin` (or `none` if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.\n\nSee \"[List repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)\" for valid repository permissions.\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo include repository permissions in an organization role, you must also include the `base_role`\nfield, which is one of `read`, `write`, `triage`, `maintain`, or `admin` (or `none` if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.\n\nSee \"[List repository permissions](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)\" for valid repository permissions.\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/create-custom-organization-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#create-a-custom-organization-role" }, "parameters": [ { @@ -236175,14 +242948,14 @@ "/orgs/{org}/organization-roles/teams/{team_slug}": { "delete": { "summary": "Remove all organization roles for a team", - "description": "Removes all assigned organization roles from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Removes all assigned organization roles from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/revoke-all-org-roles-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team" }, "parameters": [ { @@ -236220,14 +242993,14 @@ "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { "put": { "summary": "Assign an organization role to a team", - "description": "Assigns an organization role to a team in an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Assigns an organization role to a team in an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/assign-team-to-org-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#assign-an-organization-role-to-a-team" }, "parameters": [ { @@ -236278,14 +243051,14 @@ }, "delete": { "summary": "Remove an organization role from a team", - "description": "Removes an organization role from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Removes an organization role from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/revoke-org-role-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#remove-an-organization-role-from-a-team" }, "parameters": [ { @@ -236332,14 +243105,14 @@ "/orgs/{org}/organization-roles/users/{username}": { "delete": { "summary": "Remove all organization roles for a user", - "description": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/revoke-all-org-roles-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user" }, "parameters": [ { @@ -236377,14 +243150,14 @@ "/orgs/{org}/organization-roles/users/{username}/{role_id}": { "put": { "summary": "Assign an organization role to a user", - "description": "Assigns an organization role to a member of an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Assigns an organization role to a member of an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/assign-user-to-org-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#assign-an-organization-role-to-a-user" }, "parameters": [ { @@ -236435,14 +243208,14 @@ }, "delete": { "summary": "Remove an organization role from a user", - "description": "Remove an organization role from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Remove an organization role from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/revoke-org-role-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#remove-an-organization-role-from-a-user" }, "parameters": [ { @@ -236489,14 +243262,14 @@ "/orgs/{org}/organization-roles/{role_id}": { "get": { "summary": "Get an organization role", - "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/get-org-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#get-an-organization-role" }, "parameters": [ { @@ -236919,14 +243692,14 @@ }, "patch": { "summary": "Update a custom organization role", - "description": "Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nIf the update would add repository permissions, the `base_role` must also be set to a value besides `none`, either\npreviously or as part of the update.\nIf the update sets the `base_role` field to `none`, you must also remove all of the repository\npermissions as well, otherwise the update will fail.\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nIf the update would add repository permissions, the `base_role` must also be set to a value besides `none`, either\npreviously or as part of the update.\nIf the update sets the `base_role` field to `none`, you must also remove all of the repository\npermissions as well, otherwise the update will fail.\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/patch-custom-organization-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#update-a-custom-organization-role" }, "parameters": [ { @@ -237421,14 +244194,14 @@ }, "delete": { "summary": "Delete a custom organization role.", - "description": "Deletes a custom organization role. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Deletes a custom organization role. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/delete-custom-organization-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#delete-a-custom-organization-role" }, "parameters": [ { @@ -237466,14 +244239,14 @@ "/orgs/{org}/organization-roles/{role_id}/teams": { "get": { "summary": "List teams that are assigned to an organization role", - "description": "Lists the teams that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Lists the teams that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-org-role-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role" }, "parameters": [ { @@ -237496,7 +244269,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -237505,7 +244278,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -237840,14 +244613,14 @@ "/orgs/{org}/organization-roles/{role_id}/users": { "get": { "summary": "List users that are assigned to an organization role", - "description": "Lists organization members that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Lists organization members that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-org-role-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role" }, "parameters": [ { @@ -237870,7 +244643,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -237879,7 +244652,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -238275,7 +245048,7 @@ "operationId": "orgs/list-outside-collaborators", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization" }, "parameters": [ { @@ -238289,7 +245062,7 @@ }, { "name": "filter", - "description": "Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only outside collaborators with [insecure 2FA methods](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned.", + "description": "Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only outside collaborators with [insecure 2FA methods](https://docs.github.com/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned.", "in": "query", "required": false, "schema": { @@ -238304,7 +245077,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -238313,7 +245086,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -238546,14 +245319,14 @@ "/orgs/{org}/outside_collaborators/{username}": { "put": { "summary": "Convert an organization member to outside collaborator", - "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-cloud@latest//articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", + "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-cloud@latest/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", "tags": [ "orgs" ], "operationId": "orgs/convert-member-to-outside-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator" }, "parameters": [ { @@ -238626,7 +245399,7 @@ "description": "User was converted" }, "403": { - "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"" + "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"" }, "404": { "description": "Resource not found", @@ -238671,7 +245444,7 @@ "operationId": "orgs/remove-outside-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" }, "parameters": [ { @@ -238716,7 +245489,7 @@ "response-if-user-is-a-member-of-the-organization": { "value": { "message": "You cannot specify an organization member to remove as an outside collaborator.", - "documentation_url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" + "documentation_url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" } } } @@ -238735,14 +245508,14 @@ "/orgs/{org}/packages": { "get": { "summary": "List packages for an organization", - "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/list-packages-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-packages-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-packages-for-an-organization" }, "parameters": [ { @@ -238773,7 +245546,7 @@ }, { "name": "visibility", - "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", + "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", "in": "query", "required": false, "schema": { @@ -238787,7 +245560,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -238796,7 +245569,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -240158,14 +246931,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for an organization", - "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-for-an-organization" }, "parameters": [ { @@ -241465,14 +248238,14 @@ }, "delete": { "summary": "Delete a package for an organization", - "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-a-package-for-an-organization" }, "parameters": [ { @@ -241605,14 +248378,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for an organization", - "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-a-package-for-an-organization" }, "parameters": [ { @@ -241754,14 +248527,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by an organization", - "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-all-package-versions-for-package-owned-by-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization" }, "parameters": [ { @@ -241801,7 +248574,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -241810,7 +248583,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -242093,14 +248866,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for an organization", - "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-version-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-version-for-an-organization" }, "parameters": [ { @@ -242317,14 +249090,14 @@ }, "delete": { "summary": "Delete package version for an organization", - "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-version-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-package-version-for-an-organization" }, "parameters": [ { @@ -242466,14 +249239,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore package version for an organization", - "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-version-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-package-version-for-an-organization" }, "parameters": [ { @@ -242622,7 +249395,7 @@ "operationId": "orgs/list-pat-grant-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" }, "parameters": [ { @@ -242636,7 +249409,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -242645,7 +249418,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -243258,7 +250031,7 @@ "operationId": "orgs/review-pat-grant-requests-in-bulk", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" }, "parameters": [ { @@ -243512,7 +250285,7 @@ "operationId": "orgs/review-pat-grant-request", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token" }, "parameters": [ { @@ -243750,7 +250523,7 @@ "operationId": "orgs/list-pat-grant-request-repositories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token" }, "parameters": [ { @@ -243773,7 +250546,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -243782,7 +250555,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -244976,7 +251749,7 @@ "operationId": "orgs/list-pat-grants", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources" }, "parameters": [ { @@ -244990,7 +251763,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -244999,7 +251772,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -245603,7 +252376,7 @@ "operationId": "orgs/update-pat-accesses", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens" }, "parameters": [ { @@ -245849,7 +252622,7 @@ "operationId": "orgs/update-pat-access", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources" }, "parameters": [ { @@ -246077,7 +252850,7 @@ "operationId": "orgs/list-pat-grant-repositories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to" }, "parameters": [ { @@ -246100,7 +252873,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -246109,7 +252882,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -247303,7 +254076,7 @@ "operationId": "private-registries/list-org-private-registries", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#list-private-registries-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#list-private-registries-for-an-organization" }, "parameters": [ { @@ -247317,7 +254090,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -247326,7 +254099,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -247629,14 +254402,14 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], "operationId": "private-registries/create-org-private-registry", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization" }, "parameters": [ { @@ -247695,7 +254468,7 @@ "default": false }, "encrypted_value": { - "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. Required when `auth_type` is `token` or `username_password`. Should be omitted for OIDC auth types.", + "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. Required when `auth_type` is `token` or `username_password`. Should be omitted for OIDC auth types.", "type": "string", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, @@ -247713,7 +254486,7 @@ ] }, "selected_repository_ids": { - "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`.", + "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`.", "type": "array", "items": { "type": "integer" @@ -248146,7 +254919,7 @@ "operationId": "private-registries/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization" }, "parameters": [ { @@ -248251,7 +255024,7 @@ "operationId": "private-registries/get-org-private-registry", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization" }, "parameters": [ { @@ -248472,14 +255245,14 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], "operationId": "private-registries/update-org-private-registry", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization" }, "parameters": [ { @@ -248547,7 +255320,7 @@ "default": false }, "encrypted_value": { - "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", + "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", "type": "string", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, @@ -248783,7 +255556,7 @@ "operationId": "private-registries/delete-org-private-registry", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization" }, "parameters": [ { @@ -248922,7 +255695,7 @@ "operationId": "projects/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/projects#list-projects-for-organization" }, "parameters": [ { @@ -248945,7 +255718,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -248954,7 +255727,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -248963,7 +255736,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -250029,7 +256802,7 @@ "operationId": "projects/get-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/projects#get-project-for-organization" }, "parameters": [ { @@ -251106,7 +257879,7 @@ "operationId": "projects/create-draft-item-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/drafts#create-draft-item-for-organization-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/drafts#create-draft-item-for-organization-owned-project" }, "parameters": [ { @@ -259824,7 +266597,7 @@ "operationId": "projects/list-fields-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#list-project-fields-for-organization" }, "parameters": [ { @@ -259847,7 +266620,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -259856,7 +266629,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -259865,7 +266638,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -260320,7 +267093,7 @@ "operationId": "projects/add-field-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-a-field-to-an-organization-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#add-a-field-to-an-organization-owned-project" }, "parameters": [ { @@ -261069,7 +267842,7 @@ "operationId": "projects/get-field-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#get-project-field-for-organization" }, "parameters": [ { @@ -261437,7 +268210,7 @@ "operationId": "projects/list-items-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-an-organization-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#list-items-for-an-organization-owned-project" }, "parameters": [ { @@ -261460,7 +268233,7 @@ }, { "name": "q", - "description": "Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", + "description": "Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", "in": "query", "required": false, "schema": { @@ -261489,7 +268262,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -261498,7 +268271,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -261507,7 +268280,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -262623,7 +269396,7 @@ "operationId": "projects/add-item-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-organization-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#add-item-to-organization-owned-project" }, "parameters": [ { @@ -271583,7 +278356,7 @@ "operationId": "projects/get-org-item", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-an-organization-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#get-an-item-for-an-organization-owned-project" }, "parameters": [ { @@ -272739,7 +279512,7 @@ "operationId": "projects/update-item-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#update-project-item-for-organization" }, "parameters": [ { @@ -277083,7 +283856,7 @@ "operationId": "projects/delete-item-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#delete-project-item-for-organization" }, "parameters": [ { @@ -277189,7 +283962,7 @@ "operationId": "projects/create-view-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/views#create-a-view-for-an-organization-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/views#create-a-view-for-an-organization-owned-project" }, "parameters": [ { @@ -277239,7 +284012,7 @@ }, "filter": { "type": "string", - "description": "The filter query for the view. See [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", + "description": "The filter query for the view. See [Filtering projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", "examples": [ "is:issue is:open" ] @@ -277987,7 +284760,7 @@ "operationId": "projects/list-view-items-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-an-organization-project-view" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#list-items-for-an-organization-project-view" }, "parameters": [ { @@ -278039,7 +284812,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -278048,7 +284821,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -278057,7 +284830,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -279201,7 +285974,7 @@ "operationId": "orgs/custom-properties-for-repos-get-organization-definitions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-all-custom-properties-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization" }, "parameters": [ { @@ -279432,7 +286205,7 @@ "operationId": "orgs/custom-properties-for-repos-create-or-update-organization-definitions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization" }, "parameters": [ { @@ -279819,7 +286592,7 @@ "operationId": "orgs/custom-properties-for-repos-get-organization-definition", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-a-custom-property-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#get-a-custom-property-for-an-organization" }, "parameters": [ { @@ -280039,7 +286812,7 @@ "operationId": "orgs/custom-properties-for-repos-create-or-update-organization-definition", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization" }, "parameters": [ { @@ -280363,7 +287136,7 @@ "operationId": "orgs/custom-properties-for-repos-delete-organization-definition", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#remove-a-custom-property-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization" }, "parameters": [ { @@ -280460,7 +287233,7 @@ "operationId": "orgs/custom-properties-for-repos-get-organization-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories" }, "parameters": [ { @@ -280474,7 +287247,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -280483,7 +287256,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -280492,7 +287265,7 @@ }, { "name": "repository_query", - "description": "Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-cloud@latest//articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "description": "Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-cloud@latest/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", "in": "query", "required": false, "schema": { @@ -280682,7 +287455,7 @@ "operationId": "orgs/custom-properties-for-repos-create-or-update-organization-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories" }, "parameters": [ { @@ -280932,7 +287705,7 @@ "operationId": "orgs/list-public-members", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-public-organization-members" }, "parameters": [ { @@ -280946,7 +287719,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -280955,7 +287728,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -281195,7 +287968,7 @@ "operationId": "orgs/check-public-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-public-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#check-public-organization-membership-for-a-user" }, "parameters": [ { @@ -281234,14 +288007,14 @@ }, "put": { "summary": "Set public organization membership for the authenticated user", - "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "orgs" ], "operationId": "orgs/set-public-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-public-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user" }, "parameters": [ { @@ -281310,7 +288083,7 @@ "operationId": "orgs/remove-public-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user" }, "parameters": [ { @@ -281348,14 +288121,14 @@ "/orgs/{org}/repos": { "get": { "summary": "List organization repositories", - "description": "Lists repositories for the specified organization.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", + "description": "Lists repositories for the specified organization.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", "tags": [ "repos" ], "operationId": "repos/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-organization-repositories" }, "parameters": [ { @@ -281415,7 +288188,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -281424,7 +288197,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -282538,7 +289311,7 @@ "operationId": "repos/create-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-an-organization-repository" }, "parameters": [ { @@ -282627,7 +289400,7 @@ }, "license_template": { "type": "string", - "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-cloud@latest//articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\"." + "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-cloud@latest/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\"." }, "allow_squash_merge": { "type": "boolean", @@ -287614,14 +294387,14 @@ "/orgs/{org}/repository-fine-grained-permissions": { "get": { "summary": "List repository fine-grained permissions for an organization", - "description": "Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-repo-fine-grained-permissions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization" }, "parameters": [ { @@ -287699,7 +294472,7 @@ "operationId": "repos/get-org-rulesets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-all-organization-repository-rulesets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#get-all-organization-repository-rulesets" }, "x-github": { "githubCloudOnly": false, @@ -287719,7 +294492,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -287728,7 +294501,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -287822,7 +294595,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -287832,7 +294605,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -288998,7 +295772,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -289008,7 +295782,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -289187,7 +295961,7 @@ "operationId": "repos/create-org-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#create-an-organization-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#create-an-organization-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -289254,7 +296028,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -289264,7 +296038,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -290281,7 +297056,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -290291,7 +297066,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -290478,7 +297253,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -290488,7 +297263,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -291654,7 +298430,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -291664,7 +298440,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -291930,14 +298706,14 @@ "/orgs/{org}/rulesets/rule-suites": { "get": { "summary": "List organization rule suites", - "description": "Lists suites of rule evaluations at the organization level.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", + "description": "Lists suites of rule evaluations at the organization level.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", "tags": [ "repos" ], "operationId": "repos/get-org-rule-suites", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#list-organization-rule-suites" }, "parameters": [ { @@ -292007,7 +298783,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -292016,7 +298792,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -292194,14 +298970,14 @@ "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": { "get": { "summary": "Get an organization rule suite", - "description": "Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", + "description": "Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", "tags": [ "repos" ], "operationId": "repos/get-org-rule-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#get-an-organization-rule-suite" }, "parameters": [ { @@ -292215,7 +298991,7 @@ }, { "name": "rule_suite_id", - "description": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.", + "description": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.", "in": "path", "required": true, "schema": { @@ -292484,7 +299260,7 @@ "operationId": "repos/get-org-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-an-organization-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#get-an-organization-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -292584,7 +299360,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -292594,7 +299370,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -293760,7 +300537,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -293770,7 +300547,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -293966,7 +300743,7 @@ "operationId": "repos/update-org-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#update-an-organization-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#update-an-organization-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -294041,7 +300818,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -294051,7 +300828,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -295068,7 +301846,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -295078,7 +301856,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -295261,7 +302039,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -295271,7 +302049,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -296437,7 +303216,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -296447,7 +303226,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -296718,7 +303497,7 @@ "operationId": "repos/delete-org-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#delete-an-organization-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#delete-an-organization-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -296815,7 +303594,7 @@ "operationId": "orgs/get-org-ruleset-history", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-history" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#get-organization-ruleset-history" }, "parameters": [ { @@ -296829,7 +303608,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -296838,7 +303617,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -296999,7 +303778,7 @@ "operationId": "orgs/get-org-ruleset-version", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-version" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#get-organization-ruleset-version" }, "parameters": [ { @@ -297214,7 +303993,7 @@ "operationId": "secret-scanning/list-alerts-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization" }, "parameters": [ { @@ -297242,7 +304021,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -297251,7 +304030,7 @@ { "name": "exclude_secret_types", "in": "query", - "description": "A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the `secret_type` parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "description": "A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the `secret_type` parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -297337,7 +304116,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -297346,7 +304125,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -297355,7 +304134,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.", "in": "query", "required": false, "schema": { @@ -297364,7 +304143,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.", "in": "query", "required": false, "schema": { @@ -297673,7 +304452,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -299705,7 +306484,7 @@ "operationId": "secret-scanning/list-org-pattern-configs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-organization-pattern-configurations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/push-protection#list-organization-pattern-configurations" }, "x-github": { "githubCloudOnly": false, @@ -300002,7 +306781,7 @@ "operationId": "secret-scanning/update-org-pattern-configs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-organization-pattern-configurations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/push-protection#update-organization-pattern-configurations" }, "x-github": { "githubCloudOnly": false, @@ -300368,7 +307147,7 @@ "operationId": "security-advisories/list-org-repository-advisories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization" }, "parameters": [ { @@ -300411,7 +307190,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -300420,7 +307199,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -300429,7 +307208,7 @@ }, { "name": "per_page", - "description": "The number of advisories to return per page. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of advisories to return per page. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -303007,14 +309786,14 @@ "/orgs/{org}/security-managers": { "get": { "summary": "List security manager teams", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)\" endpoints instead.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles)\" endpoints instead.", "tags": [ "orgs" ], "operationId": "orgs/list-security-manager-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/security-managers#list-security-manager-teams" }, "parameters": [ { @@ -303210,14 +309989,14 @@ "/orgs/{org}/security-managers/teams/{team_slug}": { "put": { "summary": "Add a security manager team", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)\" endpoints instead.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles)\" endpoints instead.", "tags": [ "orgs" ], "operationId": "orgs/add-security-manager-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/security-managers#add-a-security-manager-team" }, "parameters": [ { @@ -303257,14 +310036,14 @@ }, "delete": { "summary": "Remove a security manager team", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)\" endpoints instead.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles)\" endpoints instead.", "tags": [ "orgs" ], "operationId": "orgs/remove-security-manager-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/security-managers#remove-a-security-manager-team" }, "parameters": [ { @@ -303313,7 +310092,7 @@ "operationId": "billing/get-github-advanced-security-billing-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization" }, "parameters": [ { @@ -303340,7 +310119,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -303349,7 +310128,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -303510,7 +310289,7 @@ "operationId": "orgs/get-immutable-releases-settings", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-immutable-releases-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization" }, "parameters": [ { @@ -303581,7 +310360,7 @@ "operationId": "orgs/set-immutable-releases-settings", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#set-immutable-releases-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization" }, "parameters": [ { @@ -303620,7 +310399,7 @@ }, "selected_repository_ids": { "type": "array", - "description": "An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints.", + "description": "An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints.", "items": { "type": "integer" } @@ -303658,7 +310437,7 @@ "operationId": "orgs/get-immutable-releases-settings-repositories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement" }, "parameters": [ { @@ -303672,7 +310451,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -303681,7 +310460,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -304750,7 +311529,7 @@ "operationId": "orgs/set-immutable-releases-settings-repositories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement" }, "parameters": [ { @@ -304772,7 +311551,7 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints.", + "description": "An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints.", "items": { "type": "integer" } @@ -304817,7 +311596,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization" }, "parameters": [ { @@ -304860,7 +311639,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization" }, "parameters": [ { @@ -304905,7 +311684,7 @@ "operationId": "hosted-compute/list-network-configurations-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization" }, "parameters": [ { @@ -304919,7 +311698,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -304928,7 +311707,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -305086,7 +311865,7 @@ "operationId": "hosted-compute/create-network-configuration-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization" }, "parameters": [ { @@ -305274,7 +312053,7 @@ "operationId": "hosted-compute/get-network-configuration-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization" }, "parameters": [ { @@ -305416,7 +312195,7 @@ "operationId": "hosted-compute/update-network-configuration-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization" }, "parameters": [ { @@ -305607,7 +312386,7 @@ "operationId": "hosted-compute/delete-network-configuration-from-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization" }, "parameters": [ { @@ -305652,7 +312431,7 @@ "operationId": "hosted-compute/get-network-settings-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization" }, "parameters": [ { @@ -305768,7 +312547,7 @@ "operationId": "teams/list-idp-groups-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#list-idp-groups-for-an-organization" }, "parameters": [ { @@ -305782,7 +312561,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -305930,7 +312709,7 @@ "operationId": "copilot/copilot-metrics-for-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team" }, "parameters": [ { @@ -305971,7 +312750,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -305980,7 +312759,7 @@ }, { "name": "per_page", - "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -306595,7 +313374,7 @@ "operationId": "teams/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-teams" }, "parameters": [ { @@ -306609,7 +313388,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -306618,7 +313397,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -306627,7 +313406,7 @@ }, { "name": "team_type", - "description": "Filter team results by their type. For more information, see \"[What kind of team should I use?](https://docs.github.com/enterprise-cloud@latest//enterprise-cloud@latest/admin/concepts/enterprise-fundamentals/teams-in-an-enterprise#what-kind-of-team-should-i-use)\"", + "description": "Filter team results by their type. For more information, see \"[What kind of team should I use?](https://docs.github.com/enterprise-cloud@latest/enterprise-cloud@latest/admin/concepts/enterprise-fundamentals/teams-in-an-enterprise#what-kind-of-team-should-i-use)\"", "in": "query", "required": false, "schema": { @@ -306973,14 +313752,14 @@ }, "post": { "summary": "Create a team", - "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/enterprise-cloud@latest//articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/about-teams)\".", + "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/enterprise-cloud@latest/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", "tags": [ "teams" ], "operationId": "teams/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#create-a-team" }, "parameters": [ { @@ -307943,7 +314722,7 @@ "operationId": "teams/get-by-name", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#get-a-team-by-name" }, "parameters": [ { @@ -308761,7 +315540,7 @@ "operationId": "teams/update-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#update-a-team" }, "parameters": [ { @@ -310495,7 +317274,7 @@ "operationId": "teams/delete-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#delete-a-team" }, "parameters": [ { @@ -310536,14 +317315,14 @@ "/orgs/{org}/teams/{team_slug}/external-groups": { "get": { "summary": "List a connection between an external group and a team", - "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/list-linked-external-idp-groups-to-team-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -310658,14 +317437,14 @@ }, "patch": { "summary": "Update the connection between an external group and a team", - "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/link-external-idp-group-to-team-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -310898,14 +317677,14 @@ }, "delete": { "summary": "Remove the connection between an external group and a team", - "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/unlink-external-idp-group-from-team-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -310953,7 +317732,7 @@ "operationId": "teams/list-pending-invitations-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-pending-team-invitations" }, "parameters": [ { @@ -310976,7 +317755,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -310985,7 +317764,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -311314,7 +318093,7 @@ "operationId": "teams/list-members-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-team-members" }, "parameters": [ { @@ -311352,7 +318131,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -311361,7 +318140,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -311594,14 +318373,14 @@ "/orgs/{org}/teams/{team_slug}/memberships/{username}": { "get": { "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team).", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#create-a-team).", "tags": [ "teams" ], "operationId": "teams/get-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-membership-for-a-user" }, "parameters": [ { @@ -311699,14 +318478,14 @@ }, "put": { "summary": "Add or update team membership for a user", - "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], "operationId": "teams/add-or-update-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-or-update-team-membership-for-a-user" }, "parameters": [ { @@ -311836,14 +318615,14 @@ }, "delete": { "summary": "Remove team membership for a user", - "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], "operationId": "teams/remove-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-membership-for-a-user" }, "parameters": [ { @@ -311900,7 +318679,7 @@ "operationId": "teams/list-repos-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-team-repositories" }, "parameters": [ { @@ -311923,7 +318702,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -311932,7 +318711,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -313041,14 +319820,14 @@ "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { "get": { "summary": "Check team permissions for a repository", - "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ "teams" ], "operationId": "teams/check-permissions-for-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#check-team-permissions-for-a-repository" }, "parameters": [ { @@ -314135,14 +320914,14 @@ }, "put": { "summary": "Add or update team repository permissions", - "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", + "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", "tags": [ "teams" ], "operationId": "teams/add-or-update-repo-permissions-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#add-or-update-team-repository-permissions" }, "parameters": [ { @@ -314227,7 +321006,7 @@ "operationId": "teams/remove-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#remove-a-repository-from-a-team" }, "parameters": [ { @@ -314283,14 +321062,14 @@ "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings": { "get": { "summary": "List IdP groups for a team", - "description": "List IdP groups connected to a team on GitHub Enterprise Cloud.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", + "description": "List IdP groups connected to a team on GitHub Enterprise Cloud.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", "tags": [ "teams" ], "operationId": "teams/list-idp-groups-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#list-idp-groups-for-a-team" }, "parameters": [ { @@ -314422,14 +321201,14 @@ }, "patch": { "summary": "Create or update IdP group connections", - "description": "Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", + "description": "Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", "tags": [ "teams" ], "operationId": "teams/create-or-update-idp-group-connections-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#create-or-update-idp-group-connections" }, "parameters": [ { @@ -314622,7 +321401,7 @@ "operationId": "teams/list-child-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-child-teams" }, "parameters": [ { @@ -314645,7 +321424,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -314654,7 +321433,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -314983,14 +321762,14 @@ "/orgs/{org}/{security_product}/{enablement}": { "post": { "summary": "Enable or disable a security feature for an organization", - "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" }, "parameters": [ { @@ -315081,14 +321860,14 @@ "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-cloud@latest/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-cloud@latest/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/enterprise-cloud@latest/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ "rate-limit" ], "operationId": "rate-limit/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" }, "parameters": [], "responses": { @@ -315573,14 +322352,14 @@ "/repos/{owner}/{repo}": { "get": { "summary": "Get a repository", - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.", "tags": [ "repos" ], "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository" }, "parameters": [ { @@ -320486,14 +327265,14 @@ }, "patch": { "summary": "Update a repository", - "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics) endpoint.", + "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#replace-all-repository-topics) endpoint.", "tags": [ "repos" ], "operationId": "repos/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#update-a-repository" }, "parameters": [ { @@ -320536,7 +327315,7 @@ }, "private": { "type": "boolean", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-cloud@latest//articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-cloud@latest/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "default": false }, "visibility": { @@ -320553,7 +327332,7 @@ "object", "null" ], - "description": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", + "description": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", "properties": { "advanced_security": { "type": "object", @@ -320597,7 +327376,7 @@ }, "secret_scanning_ai_detection": { "type": "object", - "description": "Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see \"[Responsible detection of generic secrets with AI](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets).\"", + "description": "Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see \"[Responsible detection of generic secrets with AI](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets).\"", "properties": { "status": { "type": "string", @@ -325757,7 +332536,7 @@ "operationId": "repos/delete", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository" }, "parameters": [ { @@ -325802,7 +332581,7 @@ "default": { "value": { "message": "Organization members cannot delete repositories.", - "documentation_url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository" + "documentation_url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository" } } } @@ -325906,7 +332685,7 @@ "operationId": "actions/list-artifacts-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#list-artifacts-for-a-repository" }, "parameters": [ { @@ -325929,7 +332708,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -325938,7 +332717,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -326184,7 +332963,7 @@ "operationId": "actions/get-artifact", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#get-an-artifact" }, "parameters": [ { @@ -326394,7 +333173,7 @@ "operationId": "actions/delete-artifact", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#delete-an-artifact" }, "parameters": [ { @@ -326448,7 +333227,7 @@ "operationId": "actions/download-artifact", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#download-an-artifact" }, "parameters": [ { @@ -326544,7 +333323,7 @@ "operationId": "actions/get-actions-cache-retention-limit-for-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository" }, "parameters": [ { @@ -326664,7 +333443,7 @@ "operationId": "actions/set-actions-cache-retention-limit-for-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository" }, "parameters": [ { @@ -326857,7 +333636,7 @@ "operationId": "actions/get-actions-cache-storage-limit-for-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository" }, "parameters": [ { @@ -326977,7 +333756,7 @@ "operationId": "actions/set-actions-cache-storage-limit-for-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository" }, "parameters": [ { @@ -327170,7 +333949,7 @@ "operationId": "actions/get-actions-cache-usage", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-usage-for-a-repository" }, "parameters": [ { @@ -327261,7 +334040,7 @@ "operationId": "actions/get-actions-cache-list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-github-actions-caches-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#list-github-actions-caches-for-a-repository" }, "parameters": [ { @@ -327284,7 +334063,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -327293,7 +334072,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -327471,7 +334250,7 @@ "operationId": "actions/delete-actions-cache-by-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key" }, "parameters": [ { @@ -327627,7 +334406,7 @@ "operationId": "actions/delete-actions-cache-by-id", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id" }, "parameters": [ { @@ -327681,7 +334460,7 @@ "operationId": "actions/get-job-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#get-a-job-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run" }, "parameters": [ { @@ -328155,7 +334934,7 @@ "operationId": "actions/download-job-logs-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run" }, "parameters": [ { @@ -328217,7 +334996,7 @@ "operationId": "actions/re-run-job-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run" }, "parameters": [ { @@ -328338,7 +335117,7 @@ "operationId": "actions/get-custom-oidc-sub-claim-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository" }, "parameters": [ { @@ -328380,6 +335159,14 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether the repository has opted in to the immutable OIDC subject claim format. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim. If not set at the repository level, falls back to the organization-level setting.", + "type": "boolean" + }, + "sub_claim_prefix": { + "description": "The current `sub` claim prefix for this repository.", + "type": "string" } }, "required": [ @@ -328511,7 +335298,7 @@ "operationId": "actions/set-custom-oidc-sub-claim-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository" }, "parameters": [ { @@ -328555,6 +335342,10 @@ "items": { "type": "string" } + }, + "use_immutable_subject": { + "description": "Whether to opt in to the immutable OIDC subject claim format for this repository. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim.", + "type": "boolean" } } }, @@ -328735,7 +335526,7 @@ "operationId": "actions/list-repo-organization-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-repository-organization-secrets" }, "parameters": [ { @@ -328758,7 +335549,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -328767,7 +335558,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -328871,7 +335662,7 @@ "operationId": "actions/list-repo-organization-variables", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-repository-organization-variables" }, "parameters": [ { @@ -328894,7 +335685,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -328903,7 +335694,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -329024,7 +335815,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-github-actions-permissions-for-a-repository" }, "parameters": [ { @@ -329110,7 +335901,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-github-actions-permissions-for-a-repository" }, "parameters": [ { @@ -329189,14 +335980,14 @@ "/repos/{owner}/{repo}/actions/permissions/access": { "get": { "summary": "Get the level of access for workflows outside of the repository", - "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" and\n\"[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" and\n\"[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-workflow-access-to-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository" }, "parameters": [ { @@ -329262,14 +336053,14 @@ }, "put": { "summary": "Set the level of access for workflows outside of the repository", - "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" and\n\"[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" and\n\"[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/set-workflow-access-to-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository" }, "parameters": [ { @@ -329347,7 +336138,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository" }, "parameters": [ { @@ -329444,7 +336235,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository" }, "parameters": [ { @@ -329616,7 +336407,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository" }, "parameters": [ { @@ -329712,7 +336503,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository" }, "parameters": [ { @@ -329889,7 +336680,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository" }, "parameters": [ { @@ -330024,7 +336815,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository" }, "parameters": [ { @@ -330210,7 +337001,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository" }, "parameters": [ { @@ -330289,7 +337080,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository" }, "parameters": [ { @@ -330366,14 +337157,14 @@ "/repos/{owner}/{repo}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for a repository", - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-github-actions-default-workflow-permissions-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-default-workflow-permissions-for-a-repository" }, "parameters": [ { @@ -330443,14 +337234,14 @@ }, "put": { "summary": "Set default workflow permissions for a repository", - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/set-github-actions-default-workflow-permissions-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-default-workflow-permissions-for-a-repository" }, "parameters": [ { @@ -330531,7 +337322,7 @@ "operationId": "actions/list-self-hosted-runners-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository" }, "parameters": [ { @@ -330562,7 +337353,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -330571,7 +337362,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -330778,7 +337569,7 @@ "operationId": "actions/list-runner-applications-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository" }, "parameters": [ { @@ -330898,7 +337689,7 @@ "operationId": "actions/generate-runner-jitconfig-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository" }, "parameters": [ { @@ -331217,7 +338008,7 @@ "operationId": "actions/create-registration-token-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository" }, "parameters": [ { @@ -332298,7 +339089,7 @@ "operationId": "actions/create-remove-token-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository" }, "parameters": [ { @@ -333379,7 +340170,7 @@ "operationId": "actions/get-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -333554,7 +340345,7 @@ "operationId": "actions/delete-self-hosted-runner-from-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository" }, "parameters": [ { @@ -333638,7 +340429,7 @@ "operationId": "actions/list-labels-for-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -333790,7 +340581,7 @@ "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -334006,7 +340797,7 @@ "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -334222,7 +341013,7 @@ "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -334371,7 +341162,7 @@ "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -334557,14 +341348,14 @@ "/repos/{owner}/{repo}/actions/runs": { "get": { "summary": "List workflow runs for a repository", - "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", + "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", "tags": [ "actions" ], "operationId": "actions/list-workflow-runs-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#list-workflow-runs-for-a-repository" }, "parameters": [ { @@ -334605,7 +341396,7 @@ }, { "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/enterprise-cloud@latest//actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/enterprise-cloud@latest/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", "in": "query", "required": false, "schema": { @@ -334639,7 +341430,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -334648,7 +341439,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -334657,7 +341448,7 @@ }, { "name": "created", - "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", "in": "query", "required": false, "schema": { @@ -337664,7 +344455,7 @@ "operationId": "actions/get-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-a-workflow-run" }, "parameters": [ { @@ -340663,7 +347454,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#delete-a-workflow-run" }, "parameters": [ { @@ -340717,7 +347508,7 @@ "operationId": "actions/get-reviews-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run" }, "parameters": [ { @@ -341069,14 +347860,14 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/approve": { "post": { "summary": "Approve a workflow run for a fork pull request", - "description": "Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see [\"Approving workflow runs from public forks](https://docs.github.com/enterprise-cloud@latest//actions/managing-workflow-runs/approving-workflow-runs-from-public-forks).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see [\"Approving workflow runs from public forks](https://docs.github.com/enterprise-cloud@latest/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/approve-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request" }, "parameters": [ { @@ -341198,7 +347989,7 @@ "operationId": "actions/list-workflow-run-artifacts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#list-workflow-run-artifacts" }, "parameters": [ { @@ -341230,7 +348021,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -341239,7 +348030,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -341499,7 +348290,7 @@ "operationId": "actions/get-workflow-run-attempt", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-a-workflow-run-attempt" }, "parameters": [ { @@ -344502,14 +351293,14 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { "get": { "summary": "List jobs for a workflow run attempt", - "description": "Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "actions" ], "operationId": "actions/list-jobs-for-workflow-run-attempt", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt" }, "parameters": [ { @@ -344550,7 +351341,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -344559,7 +351350,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -345064,7 +351855,7 @@ "operationId": "actions/download-workflow-run-attempt-logs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#download-workflow-run-attempt-logs" }, "parameters": [ { @@ -345135,7 +351926,7 @@ "operationId": "actions/cancel-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#cancel-a-workflow-run" }, "parameters": [ { @@ -345224,14 +352015,14 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { "post": { "summary": "Review custom deployment protection rules for a workflow run", - "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n> [!NOTE]\n> GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n> [!NOTE]\n> GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "actions" ], "operationId": "actions/review-custom-gates-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run" }, "parameters": [ { @@ -345348,7 +352139,7 @@ "operationId": "actions/force-cancel-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#force-cancel-a-workflow-run" }, "parameters": [ { @@ -345437,14 +352228,14 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { "get": { "summary": "List jobs for a workflow run", - "description": "Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "actions" ], "operationId": "actions/list-jobs-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run" }, "parameters": [ { @@ -345490,7 +352281,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -345499,7 +352290,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -345978,7 +352769,7 @@ "operationId": "actions/download-workflow-run-logs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#download-workflow-run-logs" }, "parameters": [ { @@ -346038,7 +352829,7 @@ "operationId": "actions/delete-workflow-run-logs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#delete-workflow-run-logs" }, "parameters": [ { @@ -346144,7 +352935,7 @@ "operationId": "actions/get-pending-deployments-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run" }, "parameters": [ { @@ -346789,7 +353580,7 @@ "operationId": "actions/review-pending-deployments-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run" }, "parameters": [ { @@ -347676,7 +354467,7 @@ "operationId": "actions/re-run-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-a-workflow" }, "parameters": [ { @@ -347771,7 +354562,7 @@ "operationId": "actions/re-run-workflow-failed-jobs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run" }, "parameters": [ { @@ -347859,14 +354650,14 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { "get": { "summary": "Get workflow run usage", - "description": "> [!WARNING] \n> This endpoint is in the process of closing down. Refer to \"[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)\" for more information.\n\nGets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "> [!WARNING] \n> This endpoint is in the process of closing down. Refer to \"[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)\" for more information.\n\nGets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "actions" ], "operationId": "actions/get-workflow-run-usage", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-workflow-run-usage" }, "parameters": [ { @@ -348096,7 +354887,7 @@ "operationId": "actions/list-repo-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-repository-secrets" }, "parameters": [ { @@ -348119,7 +354910,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -348128,7 +354919,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -348232,7 +355023,7 @@ "operationId": "actions/get-repo-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-public-key" }, "parameters": [ { @@ -348338,7 +355129,7 @@ "operationId": "actions/get-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-secret" }, "parameters": [ { @@ -348423,14 +355214,14 @@ }, "put": { "summary": "Create or update a repository secret", - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/create-or-update-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-a-repository-secret" }, "parameters": [ { @@ -348470,7 +355261,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -348534,7 +355325,7 @@ "operationId": "actions/delete-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-a-repository-secret" }, "parameters": [ { @@ -348588,7 +355379,7 @@ "operationId": "actions/list-repo-variables", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-repository-variables" }, "parameters": [ { @@ -348611,7 +355402,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -348620,7 +355411,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -348739,7 +355530,7 @@ "operationId": "actions/create-repo-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-a-repository-variable" }, "parameters": [ { @@ -348832,7 +355623,7 @@ "operationId": "actions/get-repo-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-a-repository-variable" }, "parameters": [ { @@ -348940,7 +355731,7 @@ "operationId": "actions/update-repo-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-a-repository-variable" }, "parameters": [ { @@ -349020,7 +355811,7 @@ "operationId": "actions/delete-repo-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-a-repository-variable" }, "parameters": [ { @@ -349074,7 +355865,7 @@ "operationId": "actions/list-repo-workflows", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#list-repository-workflows" }, "parameters": [ { @@ -349097,7 +355888,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -349106,7 +355897,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -349292,7 +356083,7 @@ "operationId": "actions/get-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#get-a-workflow" }, "parameters": [ { @@ -349468,7 +356259,7 @@ "operationId": "actions/disable-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#disable-a-workflow" }, "parameters": [ { @@ -349529,7 +356320,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#create-a-workflow-dispatch-event" }, "parameters": [ { @@ -349673,7 +356464,7 @@ "operationId": "actions/enable-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#enable-a-workflow" }, "parameters": [ { @@ -349727,14 +356518,14 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { "get": { "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-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", + "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-cloud@latest/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", "tags": [ "actions" ], "operationId": "actions/list-workflow-runs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-workflow" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow" }, "parameters": [ { @@ -349791,7 +356582,7 @@ }, { "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/enterprise-cloud@latest//actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/enterprise-cloud@latest/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", "in": "query", "required": false, "schema": { @@ -349825,7 +356616,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -349834,7 +356625,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -349843,7 +356634,7 @@ }, { "name": "created", - "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", "in": "query", "required": false, "schema": { @@ -352843,14 +359634,14 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { "get": { "summary": "Get workflow usage", - "description": "> [!WARNING] \n> This endpoint is in the process of closing down. Refer to \"[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)\" for more information.\n\nGets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "> [!WARNING] \n> This endpoint is in the process of closing down. Refer to \"[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)\" for more information.\n\nGets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "actions" ], "operationId": "actions/get-workflow-usage", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#get-workflow-usage" }, "parameters": [ { @@ -352964,14 +359755,14 @@ "/repos/{owner}/{repo}/activity": { "get": { "summary": "List repository activities", - "description": "Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.\n\nFor more information about viewing repository activity,\nsee \"[Viewing activity and data for your repository](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository).\"", + "description": "Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.\n\nFor more information about viewing repository activity,\nsee \"[Viewing activity and data for your repository](https://docs.github.com/enterprise-cloud@latest/repositories/viewing-activity-and-data-for-your-repository).\"", "tags": [ "repos" ], "operationId": "repos/list-activities", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-activities" }, "parameters": [ { @@ -353008,7 +359799,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -353017,7 +359808,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -353026,7 +359817,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -353429,14 +360220,14 @@ "/repos/{owner}/{repo}/assignees": { "get": { "summary": "List assignees", - "description": "Lists the [available assignees](https://docs.github.com/enterprise-cloud@latest//articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", + "description": "Lists the [available assignees](https://docs.github.com/enterprise-cloud@latest/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", "tags": [ "issues" ], "operationId": "issues/list-assignees", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#list-assignees" }, "parameters": [ { @@ -353459,7 +360250,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -353468,7 +360259,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -353734,7 +360525,7 @@ "operationId": "issues/check-user-can-be-assigned", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#check-if-a-user-can-be-assigned" }, "parameters": [ { @@ -353806,14 +360597,14 @@ "/repos/{owner}/{repo}/attestations": { "post": { "summary": "Create an attestation", - "description": "Store an artifact attestation and associate it with a repository.\n\nThe authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required.\n\nArtifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "description": "Store an artifact attestation and associate it with a repository.\n\nThe authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required.\n\nArtifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", "tags": [ "repos" ], "operationId": "repos/create-attestation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#create-an-attestation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/attestations#create-an-attestation" }, "parameters": [ { @@ -354070,14 +360861,14 @@ "/repos/{owner}/{repo}/attestations/{subject_digest}": { "get": { "summary": "List attestations", - "description": "List a collection of artifact attestations with a given subject digest that are associated with a repository.\n\nThe authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "description": "List a collection of artifact attestations with a given subject digest that are associated with a repository.\n\nThe authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", "tags": [ "repos" ], "operationId": "repos/list-attestations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#list-attestations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/attestations#list-attestations" }, "parameters": [ { @@ -354100,7 +360891,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -354109,7 +360900,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -354118,7 +360909,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -354343,7 +361134,7 @@ "operationId": "repos/list-autolinks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#get-all-autolinks-of-a-repository" }, "parameters": [ { @@ -354452,7 +361243,7 @@ "operationId": "repos/create-autolink", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#create-an-autolink-reference-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#create-an-autolink-reference-for-a-repository" }, "parameters": [ { @@ -354679,7 +361470,7 @@ "operationId": "repos/get-autolink", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-an-autolink-reference-of-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#get-an-autolink-reference-of-a-repository" }, "parameters": [ { @@ -354818,7 +361609,7 @@ "operationId": "repos/delete-autolink", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#delete-an-autolink-reference-from-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository" }, "parameters": [ { @@ -354891,14 +361682,14 @@ "/repos/{owner}/{repo}/automated-security-fixes": { "get": { "summary": "Check if Dependabot security updates are enabled for a repository", - "description": "Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[Configuring Dependabot security updates](https://docs.github.com/enterprise-cloud@latest//articles/configuring-automated-security-fixes)\".", + "description": "Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[Configuring Dependabot security updates](https://docs.github.com/enterprise-cloud@latest/articles/configuring-automated-security-fixes)\".", "tags": [ "repos" ], "operationId": "repos/check-automated-security-fixes", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository" }, "parameters": [ { @@ -354974,14 +361765,14 @@ }, "put": { "summary": "Enable Dependabot security updates", - "description": "Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring Dependabot security updates](https://docs.github.com/enterprise-cloud@latest//articles/configuring-automated-security-fixes)\".", + "description": "Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring Dependabot security updates](https://docs.github.com/enterprise-cloud@latest/articles/configuring-automated-security-fixes)\".", "tags": [ "repos" ], "operationId": "repos/enable-automated-security-fixes", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-dependabot-security-updates" }, "parameters": [ { @@ -355017,14 +361808,14 @@ }, "delete": { "summary": "Disable Dependabot security updates", - "description": "Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring Dependabot security updates](https://docs.github.com/enterprise-cloud@latest//articles/configuring-automated-security-fixes)\".", + "description": "Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring Dependabot security updates](https://docs.github.com/enterprise-cloud@latest/articles/configuring-automated-security-fixes)\".", "tags": [ "repos" ], "operationId": "repos/disable-automated-security-fixes", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-dependabot-security-updates" }, "parameters": [ { @@ -355069,7 +361860,7 @@ "operationId": "repos/list-branches", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#list-branches" }, "parameters": [ { @@ -355101,7 +361892,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -355110,7 +361901,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -357705,7 +364496,7 @@ "operationId": "repos/get-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#get-a-branch" }, "parameters": [ { @@ -357728,7 +364519,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -361151,14 +367942,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection": { "get": { "summary": "Get branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-branch-protection" }, "parameters": [ { @@ -361181,7 +367972,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -363902,14 +370693,14 @@ }, "put": { "summary": "Update branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.\n\n> [!NOTE]\n> The list of users, apps, and teams in total is limited to 100 items.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.\n\n> [!NOTE]\n> The list of users, apps, and teams in total is limited to 100 items.", "tags": [ "repos" ], "operationId": "repos/update-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-branch-protection" }, "parameters": [ { @@ -363932,7 +370723,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -364040,7 +370831,7 @@ }, "require_code_owner_reviews": { "type": "boolean", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-cloud@latest//articles/about-code-owners/) review them." + "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-cloud@latest/articles/about-code-owners/) review them." }, "required_approving_review_count": { "type": "integer", @@ -364116,18 +370907,18 @@ }, "required_linear_history": { "type": "boolean", - "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation." + "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation." }, "allow_force_pushes": { "type": [ "boolean", "null" ], - "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"" + "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"" }, "allow_deletions": { "type": "boolean", - "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation." + "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation." }, "block_creations": { "type": "boolean", @@ -366842,14 +373633,14 @@ }, "delete": { "summary": "Delete branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/delete-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-branch-protection" }, "parameters": [ { @@ -366872,7 +373663,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -366923,14 +373714,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { "get": { "summary": "Get admin branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-admin-branch-protection" }, "parameters": [ { @@ -366953,7 +373744,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -367012,14 +373803,14 @@ }, "post": { "summary": "Set admin branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", "tags": [ "repos" ], "operationId": "repos/set-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-admin-branch-protection" }, "parameters": [ { @@ -367042,7 +373833,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -367101,14 +373892,14 @@ }, "delete": { "summary": "Delete admin branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", "tags": [ "repos" ], "operationId": "repos/delete-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-admin-branch-protection" }, "parameters": [ { @@ -367131,7 +373922,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -367182,14 +373973,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { "get": { "summary": "Get pull request review protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-pull-request-review-protection" }, "parameters": [ { @@ -367212,7 +374003,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -369080,14 +375871,14 @@ }, "patch": { "summary": "Update pull request review protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.", "tags": [ "repos" ], "operationId": "repos/update-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-pull-request-review-protection" }, "parameters": [ { @@ -369110,7 +375901,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -369159,7 +375950,7 @@ }, "require_code_owner_reviews": { "type": "boolean", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-cloud@latest//articles/about-code-owners/) have reviewed." + "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-cloud@latest/articles/about-code-owners/) have reviewed." }, "required_approving_review_count": { "type": "integer", @@ -371168,14 +377959,14 @@ }, "delete": { "summary": "Delete pull request review protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/delete-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-pull-request-review-protection" }, "parameters": [ { @@ -371198,7 +377989,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -371249,14 +378040,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { "get": { "summary": "Get commit signature protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-cloud@latest//articles/signing-commits-with-gpg) in GitHub Help.\n\n> [!NOTE]\n> You must enable branch protection to require signed commits.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-cloud@latest/articles/signing-commits-with-gpg) in GitHub Help.\n\n> [!NOTE]\n> You must enable branch protection to require signed commits.", "tags": [ "repos" ], "operationId": "repos/get-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-commit-signature-protection" }, "parameters": [ { @@ -371279,7 +378070,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -371364,14 +378155,14 @@ }, "post": { "summary": "Create commit signature protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", "tags": [ "repos" ], "operationId": "repos/create-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#create-commit-signature-protection" }, "parameters": [ { @@ -371394,7 +378185,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -371479,14 +378270,14 @@ }, "delete": { "summary": "Delete commit signature protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", "tags": [ "repos" ], "operationId": "repos/delete-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-commit-signature-protection" }, "parameters": [ { @@ -371509,7 +378300,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -371560,14 +378351,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { "get": { "summary": "Get status checks protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-status-checks-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-status-checks-protection" }, "parameters": [ { @@ -371590,7 +378381,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -371722,14 +378513,14 @@ }, "patch": { "summary": "Update status check protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", "tags": [ "repos" ], "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-status-check-protection" }, "parameters": [ { @@ -371752,7 +378543,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -372013,14 +378804,14 @@ }, "delete": { "summary": "Remove status check protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/remove-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-status-check-protection" }, "parameters": [ { @@ -372043,7 +378834,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -372068,14 +378859,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { "get": { "summary": "Get all status check contexts", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-all-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-all-status-check-contexts" }, "parameters": [ { @@ -372098,7 +378889,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -372164,14 +378955,14 @@ }, "post": { "summary": "Add status check contexts", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/add-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-status-check-contexts" }, "parameters": [ { @@ -372194,7 +378985,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -372412,14 +379203,14 @@ }, "put": { "summary": "Set status check contexts", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/set-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-status-check-contexts" }, "parameters": [ { @@ -372442,7 +379233,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -372632,14 +379423,14 @@ }, "delete": { "summary": "Remove status check contexts", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/remove-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-status-check-contexts" }, "parameters": [ { @@ -372662,7 +379453,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -372853,14 +379644,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { "get": { "summary": "Get access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n> [!NOTE]\n> Users, apps, and teams `restrictions` are only available for organization-owned repositories.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n> [!NOTE]\n> Users, apps, and teams `restrictions` are only available for organization-owned repositories.", "tags": [ "repos" ], "operationId": "repos/get-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-access-restrictions" }, "parameters": [ { @@ -372883,7 +379674,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -373553,14 +380344,14 @@ }, "delete": { "summary": "Delete access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", "tags": [ "repos" ], "operationId": "repos/delete-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-access-restrictions" }, "parameters": [ { @@ -373583,7 +380374,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -373608,14 +380399,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { "get": { "summary": "Get apps with access to the protected branch", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "tags": [ "repos" ], "operationId": "repos/get-apps-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch" }, "parameters": [ { @@ -373638,7 +380429,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -374142,14 +380933,14 @@ }, "post": { "summary": "Add app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "tags": [ "repos" ], "operationId": "repos/add-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-app-access-restrictions" }, "parameters": [ { @@ -374172,7 +380963,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -374762,14 +381553,14 @@ }, "put": { "summary": "Set app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "tags": [ "repos" ], "operationId": "repos/set-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-app-access-restrictions" }, "parameters": [ { @@ -374792,7 +381583,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -375382,14 +382173,14 @@ }, "delete": { "summary": "Remove app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "tags": [ "repos" ], "operationId": "repos/remove-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-app-access-restrictions" }, "parameters": [ { @@ -375412,7 +382203,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -376004,14 +382795,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { "get": { "summary": "Get teams with access to the protected branch", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", "tags": [ "repos" ], "operationId": "repos/get-teams-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch" }, "parameters": [ { @@ -376034,7 +382825,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -376367,14 +383158,14 @@ }, "post": { "summary": "Add team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.", "tags": [ "repos" ], "operationId": "repos/add-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-team-access-restrictions" }, "parameters": [ { @@ -376397,7 +383188,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -376828,14 +383619,14 @@ }, "put": { "summary": "Set team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.", "tags": [ "repos" ], "operationId": "repos/set-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-team-access-restrictions" }, "parameters": [ { @@ -376858,7 +383649,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -377289,14 +384080,14 @@ }, "delete": { "summary": "Remove team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.", "tags": [ "repos" ], "operationId": "repos/remove-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-team-access-restrictions" }, "parameters": [ { @@ -377319,7 +384110,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -377751,14 +384542,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { "get": { "summary": "Get users with access to the protected branch", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", "tags": [ "repos" ], "operationId": "repos/get-users-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-users-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch" }, "parameters": [ { @@ -377781,7 +384572,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -378031,14 +384822,14 @@ }, "post": { "summary": "Add user access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], "operationId": "repos/add-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-user-access-restrictions" }, "parameters": [ { @@ -378061,7 +384852,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -378398,14 +385189,14 @@ }, "put": { "summary": "Set user access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], "operationId": "repos/set-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-user-access-restrictions" }, "parameters": [ { @@ -378428,7 +385219,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -378765,14 +385556,14 @@ }, "delete": { "summary": "Remove user access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], "operationId": "repos/remove-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-user-access-restrictions" }, "parameters": [ { @@ -378795,7 +385586,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -379134,14 +385925,14 @@ "/repos/{owner}/{repo}/branches/{branch}/rename": { "post": { "summary": "Rename a branch", - "description": "Renames a branch in a repository.\n\n> [!NOTE]\n> Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/renaming-a-branch)\".\n\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.\n\nIn order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.", + "description": "Renames a branch in a repository.\n\n> [!NOTE]\n> Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/renaming-a-branch)\".\n\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.\n\nIn order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.", "tags": [ "repos" ], "operationId": "repos/rename-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#rename-a-branch" }, "parameters": [ { @@ -379164,7 +385955,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -382694,7 +389485,7 @@ "operationId": "repos/list-repo-push-bypass-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/bypass-requests#list-repository-push-rule-bypass-requests" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/bypass-requests#list-repository-push-rule-bypass-requests" }, "x-github": { "githubCloudOnly": true, @@ -382777,7 +389568,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -382786,7 +389577,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -383171,7 +389962,7 @@ "operationId": "repos/get-repo-push-bypass-request", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/bypass-requests#get-a-repository-push-bypass-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/bypass-requests#get-a-repository-push-bypass-request" }, "x-github": { "githubCloudOnly": true, @@ -383537,7 +390328,7 @@ "operationId": "secret-scanning/list-repo-bypass-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-a-repository" }, "x-github": { "githubCloudOnly": true, @@ -383620,7 +390411,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -383629,7 +390420,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -384029,7 +390820,7 @@ "operationId": "secret-scanning/get-bypass-request", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#get-a-bypass-request-for-secret-scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#get-a-bypass-request-for-secret-scanning" }, "x-github": { "githubCloudOnly": true, @@ -384407,7 +391198,7 @@ "operationId": "secret-scanning/review-bypass-request", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#review-a-bypass-request-for-secret-scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#review-a-bypass-request-for-secret-scanning" }, "x-github": { "githubCloudOnly": true, @@ -384670,7 +391461,7 @@ "operationId": "secret-scanning/dismiss-bypass-response", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#dismiss-a-response-on-a-bypass-request-for-secret-scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#dismiss-a-response-on-a-bypass-request-for-secret-scanning" }, "x-github": { "githubCloudOnly": true, @@ -384877,7 +391668,7 @@ "operationId": "checks/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#create-a-check-run" }, "parameters": [ { @@ -384979,7 +391770,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/enterprise-cloud@latest//articles/about-status-checks#checks)\".", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/enterprise-cloud@latest/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -385068,7 +391859,7 @@ }, "actions": { "type": "array", - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -386632,7 +393423,7 @@ "operationId": "checks/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#get-a-check-run" }, "parameters": [ { @@ -387998,7 +394789,7 @@ "operationId": "checks/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run" }, "parameters": [ { @@ -388104,7 +394895,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/enterprise-cloud@latest//articles/about-status-checks#checks)\".", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/enterprise-cloud@latest/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -388192,7 +394983,7 @@ }, "actions": { "type": "array", - "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"", + "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -389630,7 +396421,7 @@ "operationId": "checks/list-annotations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-run-annotations" }, "parameters": [ { @@ -389662,7 +396453,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -389671,7 +396462,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -389822,14 +396613,14 @@ "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { "post": { "summary": "Rerequest a check run", - "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run) to update the check_run if desired.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".", + "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run) to update the check_run if desired.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".", "tags": [ "checks" ], "operationId": "checks/rerequest-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#rerequest-a-check-run" }, "parameters": [ { @@ -389970,14 +396761,14 @@ "/repos/{owner}/{repo}/check-suites": { "post": { "summary": "Create a check suite", - "description": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n> [!NOTE]\n> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n> [!NOTE]\n> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], "operationId": "checks/create-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#create-a-check-suite" }, "parameters": [ { @@ -394054,14 +400845,14 @@ "/repos/{owner}/{repo}/check-suites/preferences": { "patch": { "summary": "Update repository preferences for check suites", - "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite).\nYou must have admin permissions in the repository to set preferences for check suites.", + "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#create-a-check-suite).\nYou must have admin permissions in the repository to set preferences for check suites.", "tags": [ "checks" ], "operationId": "checks/set-suites-preferences", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#update-repository-preferences-for-check-suites" }, "parameters": [ { @@ -395376,7 +402167,7 @@ "operationId": "checks/get-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite" }, "parameters": [ { @@ -397435,7 +404226,7 @@ "operationId": "checks/list-for-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-in-a-check-suite" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-runs-in-a-check-suite" }, "parameters": [ { @@ -397504,7 +404295,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -397513,7 +404304,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -398879,14 +405670,14 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { "post": { "summary": "Rerequest a check suite", - "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.", + "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.", "tags": [ "checks" ], "operationId": "checks/rerequest-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#rerequest-a-check-suite" }, "parameters": [ { @@ -398956,7 +405747,7 @@ "operationId": "code-scanning/list-alerts-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository" }, "parameters": [ { @@ -399002,7 +405793,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -399011,7 +405802,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -399053,7 +405844,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -399062,7 +405853,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -400172,7 +406963,7 @@ "operationId": "code-scanning/get-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-code-scanning-alert" }, "parameters": [ { @@ -401199,7 +407990,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#update-a-code-scanning-alert" }, "parameters": [ { @@ -402367,7 +409158,7 @@ "operationId": "code-scanning/get-autofix", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert" }, "parameters": [ { @@ -402575,7 +409366,7 @@ "operationId": "code-scanning/create-autofix", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert" }, "parameters": [ { @@ -402837,7 +409628,7 @@ "operationId": "code-scanning/commit-autofix", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert" }, "parameters": [ { @@ -403061,7 +409852,7 @@ "operationId": "code-scanning/list-alert-instances", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert" }, "parameters": [ { @@ -403095,7 +409886,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -403104,7 +409895,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -403368,7 +410159,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository" }, "parameters": [ { @@ -403414,7 +410205,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -403423,7 +410214,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -403748,14 +410539,14 @@ "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { "get": { "summary": "Get a code scanning analysis for a repository", - "description": "Gets a specified code scanning analysis for a repository.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Gets a specified code scanning analysis for a repository.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "operationId": "code-scanning/get-analysis", "tags": [ "code-scanning" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository" }, "parameters": [ { @@ -404109,7 +410900,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository" }, "parameters": [ { @@ -404358,7 +411149,7 @@ "operationId": "code-scanning/list-codeql-databases", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository" }, "parameters": [ { @@ -404773,14 +411564,14 @@ "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": { "get": { "summary": "Get a CodeQL database for a repository", - "description": "Gets a CodeQL database for a language in a repository.\n\nBy default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the `Accept` header of the request\nto [`application/zip`](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure\nyour HTTP client is configured to follow redirects or use the `Location` header\nto make a second request to get the redirect URL.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Gets a CodeQL database for a language in a repository.\n\nBy default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the `Accept` header of the request\nto [`application/zip`](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure\nyour HTTP client is configured to follow redirects or use the `Location` header\nto make a second request to get the redirect URL.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "tags": [ "code-scanning" ], "operationId": "code-scanning/get-codeql-database", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository" }, "parameters": [ { @@ -405176,7 +411967,7 @@ "operationId": "code-scanning/delete-codeql-database", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#delete-a-codeql-database" }, "parameters": [ { @@ -405297,14 +412088,14 @@ "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses": { "post": { "summary": "Create a CodeQL variant analysis", - "description": "Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories.\n\nGet started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/enterprise-cloud@latest//code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis).\n\nUse the `owner` and `repo` parameters in the URL to specify the controller repository that\nwill be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories.\n\nGet started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/enterprise-cloud@latest/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis).\n\nUse the `owner` and `repo` parameters in the URL to specify the controller repository that\nwill be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "code-scanning" ], "operationId": "code-scanning/create-variant-analysis", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-a-codeql-variant-analysis" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis" }, "parameters": [ { @@ -407223,7 +414014,7 @@ "operationId": "code-scanning/get-variant-analysis", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis" }, "parameters": [ { @@ -408658,7 +415449,7 @@ "operationId": "code-scanning/get-variant-analysis-repo-task", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis" }, "parameters": [ { @@ -409458,7 +416249,7 @@ "operationId": "code-scanning/get-default-setup", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration" }, "parameters": [ { @@ -409687,7 +416478,7 @@ "operationId": "code-scanning/update-default-setup", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration" }, "parameters": [ { @@ -409977,14 +416768,14 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.\n\nThis endpoint is limited to 1,000 requests per hour for each user or app installation calling it.", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.\n\nThis endpoint is limited to 1,000 requests per hour for each user or app installation calling it.", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data" }, "parameters": [ { @@ -410029,7 +416820,7 @@ ] }, "sarif": { - "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secure-coding/sarif-support-for-code-scanning).\"", + "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secure-coding/sarif-support-for-code-scanning).\"", "type": "string" }, "checkout_uri": { @@ -410206,7 +416997,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-information-about-a-sarif-upload" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload" }, "parameters": [ { @@ -410357,7 +417148,7 @@ "operationId": "code-security/get-configuration-for-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository" }, "parameters": [ { @@ -410823,14 +417614,14 @@ "/repos/{owner}/{repo}/codeowners/errors": { "get": { "summary": "List CODEOWNERS errors", - "description": "List any syntax errors that are detected in the CODEOWNERS\nfile.\n\nFor more information about the correct CODEOWNERS syntax,\nsee \"[About code owners](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).\"", + "description": "List any syntax errors that are detected in the CODEOWNERS\nfile.\n\nFor more information about the correct CODEOWNERS syntax,\nsee \"[About code owners](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).\"", "tags": [ "repos" ], "operationId": "repos/codeowners-errors", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-codeowners-errors" }, "parameters": [ { @@ -410995,12 +417786,12 @@ "operationId": "codespaces/list-in-repository-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -411009,7 +417800,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -413139,7 +419930,7 @@ "operationId": "codespaces/create-with-repo-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-in-a-repository" }, "parameters": [ { @@ -417067,12 +423858,12 @@ "operationId": "codespaces/list-devcontainers-in-repository-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#list-devcontainer-configurations-in-a-repository-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#list-devcontainer-configurations-in-a-repository-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -417081,7 +423872,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -417361,7 +424152,7 @@ "operationId": "codespaces/repo-machines-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-available-machine-types-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/machines#list-available-machine-types-for-a-repository" }, "parameters": [ { @@ -417661,7 +424452,7 @@ "operationId": "codespaces/pre-flight-with-repo-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#get-default-attributes-for-a-codespace" }, "parameters": [ { @@ -418031,7 +424822,7 @@ "operationId": "codespaces/check-permissions-for-devcontainer", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user" }, "parameters": [ { @@ -418302,7 +425093,7 @@ "operationId": "codespaces/list-repo-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#list-repository-secrets" }, "parameters": [ { @@ -418325,7 +425116,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -418334,7 +425125,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -418440,7 +425231,7 @@ "operationId": "codespaces/get-repo-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-public-key" }, "parameters": [ { @@ -418546,7 +425337,7 @@ "operationId": "codespaces/get-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-secret" }, "parameters": [ { @@ -418632,14 +425423,14 @@ }, "put": { "summary": "Create or update a repository secret", - "description": "Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin.", + "description": "Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin.", "tags": [ "codespaces" ], "operationId": "codespaces/create-or-update-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#create-or-update-a-repository-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#create-or-update-a-repository-secret" }, "parameters": [ { @@ -418679,7 +425470,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -418739,7 +425530,7 @@ "operationId": "codespaces/delete-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#delete-a-repository-secret" }, "parameters": [ { @@ -418793,7 +425584,7 @@ "operationId": "repos/list-collaborators", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#list-repository-collaborators" }, "parameters": [ { @@ -418847,7 +425638,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -418856,7 +425647,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -419156,7 +425947,7 @@ "operationId": "repos/check-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator" }, "parameters": [ { @@ -419204,14 +425995,14 @@ }, "put": { "summary": "Add a repository collaborator", - "description": "Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an \"outside collaborator\" (if they are not an Enterprise Managed User) or a \"repository collaborator\" if they are an Enterprise Managed User. These users are exempt from some organization policies - see \"[Adding outside collaborators to repositories](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)\" to learn more about these collaborator types.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications).\n\nAdding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)\" and \"[Setting permissions for adding outside collaborators](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)\" for organization settings.\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations).\n\nFor Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise.\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an \"outside collaborator\" (if they are not an Enterprise Managed User) or a \"repository collaborator\" if they are an Enterprise Managed User. These users are exempt from some organization policies - see \"[Adding outside collaborators to repositories](https://docs.github.com/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)\" to learn more about these collaborator types.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications).\n\nAdding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)\" and \"[Setting permissions for adding outside collaborators](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)\" for organization settings.\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations).\n\nFor Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise.\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "tags": [ "repos" ], "operationId": "repos/add-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#add-a-repository-collaborator" }, "parameters": [ { @@ -420871,14 +427662,14 @@ }, "delete": { "summary": "Remove a repository collaborator", - "description": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations sent by the collaborator\n- Unassigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n> [!NOTE]\n> A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".", + "description": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations sent by the collaborator\n- Unassigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n> [!NOTE]\n> A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".", "tags": [ "repos" ], "operationId": "repos/remove-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#remove-a-repository-collaborator" }, "parameters": [ { @@ -421033,7 +427824,7 @@ "operationId": "repos/get-collaborator-permission-level", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#get-repository-permissions-for-a-user" }, "parameters": [ { @@ -421360,14 +428151,14 @@ "/repos/{owner}/{repo}/comments": { "get": { "summary": "List commit comments for a repository", - "description": "Lists the commit comments for a specified repository. Comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists the commit comments for a specified repository. Comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/list-commit-comments-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#list-commit-comments-for-a-repository" }, "parameters": [ { @@ -421390,7 +428181,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -421399,7 +428190,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -421788,14 +428579,14 @@ "/repos/{owner}/{repo}/comments/{comment_id}": { "get": { "summary": "Get a commit comment", - "description": "Gets a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Gets a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/get-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment" }, "parameters": [ { @@ -422219,14 +429010,14 @@ }, "patch": { "summary": "Update a commit comment", - "description": "Updates the contents of a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Updates the contents of a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/update-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#update-a-commit-comment" }, "parameters": [ { @@ -422683,7 +429474,7 @@ "operationId": "repos/delete-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#delete-a-commit-comment" }, "parameters": [ { @@ -422757,14 +429548,14 @@ "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { "get": { "summary": "List reactions for a commit comment", - "description": "List the reactions to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment).", + "description": "List the reactions to a [commit comment](https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment).", "tags": [ "reactions" ], "operationId": "reactions/list-for-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-commit-comment" }, "parameters": [ { @@ -422797,7 +429588,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment.", "in": "query", "required": false, "schema": { @@ -422816,7 +429607,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -422825,7 +429616,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -423145,14 +429936,14 @@ }, "post": { "summary": "Create reaction for a commit comment", - "description": "Create a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.", + "description": "Create a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.", "tags": [ "reactions" ], "operationId": "reactions/create-for-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-commit-comment" }, "parameters": [ { @@ -423193,7 +429984,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the commit comment.", + "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions) to add to the commit comment.", "enum": [ "+1", "-1", @@ -423832,14 +430623,14 @@ "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a commit comment reaction", - "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-commit-comment-reaction" }, "parameters": [ { @@ -423903,7 +430694,7 @@ "operationId": "repos/list-commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-commits" }, "parameters": [ { @@ -423982,7 +430773,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -423991,7 +430782,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -424983,14 +431774,14 @@ "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { "get": { "summary": "List branches for HEAD commit", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", "tags": [ "repos" ], "operationId": "repos/list-branches-for-head-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-branches-for-head-commit" }, "parameters": [ { @@ -425193,14 +431984,14 @@ "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { "get": { "summary": "List commit comments", - "description": "Lists the comments for a specified commit.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists the comments for a specified commit.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/list-comments-for-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#list-commit-comments" }, "parameters": [ { @@ -425233,7 +432024,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -425242,7 +432033,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -425629,14 +432420,14 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/create-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#create-a-commit-comment" }, "parameters": [ { @@ -426194,7 +432985,7 @@ "operationId": "repos/list-pull-requests-associated-with-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-pull-requests-associated-with-a-commit" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-pull-requests-associated-with-a-commit" }, "parameters": [ { @@ -426227,7 +433018,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -426236,7 +433027,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -431017,14 +437808,14 @@ "/repos/{owner}/{repo}/commits/{ref}": { "get": { "summary": "Get a commit", - "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n> [!NOTE]\n> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\" Pagination query parameters are not supported for these media types.\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n> [!NOTE]\n> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\" Pagination query parameters are not supported for these media types.\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], "operationId": "repos/get-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#get-a-commit" }, "parameters": [ { @@ -431047,7 +437838,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -431056,7 +437847,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -432120,14 +438911,14 @@ "/repos/{owner}/{repo}/commits/{ref}/check-runs": { "get": { "summary": "List check runs for a Git reference", - "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-cloud@latest/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-cloud@latest/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], "operationId": "checks/list-for-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-for-a-git-reference" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-runs-for-a-git-reference" }, "parameters": [ { @@ -432197,7 +438988,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -432206,7 +438997,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -433587,7 +440378,7 @@ "operationId": "checks/list-suites-for-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#list-check-suites-for-a-git-reference" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#list-check-suites-for-a-git-reference" }, "parameters": [ { @@ -433639,7 +440430,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -433648,7 +440439,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -435590,7 +442381,7 @@ "operationId": "repos/get-combined-status-for-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#get-the-combined-status-for-a-specific-reference" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#get-the-combined-status-for-a-specific-reference" }, "parameters": [ { @@ -435623,7 +442414,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -435632,7 +442423,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -436846,7 +443637,7 @@ "operationId": "repos/list-commit-statuses-for-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#list-commit-statuses-for-a-reference" }, "parameters": [ { @@ -436879,7 +443670,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -436888,7 +443679,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -437225,14 +444016,14 @@ "/repos/{owner}/{repo}/community/profile": { "get": { "summary": "Get community profile metrics", - "description": "Returns all community profile metrics for a repository. The repository cannot be a fork.\n\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"[About community profiles for public repositories](https://docs.github.com/enterprise-cloud@latest//communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories).\"\n\n`content_reports_enabled` is only returned for organization-owned repositories.", + "description": "Returns all community profile metrics for a repository. The repository cannot be a fork.\n\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"[About community profiles for public repositories](https://docs.github.com/enterprise-cloud@latest/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories).\"\n\n`content_reports_enabled` is only returned for organization-owned repositories.", "tags": [ "repos" ], "operationId": "repos/get-community-profile-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/metrics/community#get-community-profile-metrics" }, "parameters": [ { @@ -437625,14 +444416,14 @@ "/repos/{owner}/{repo}/compare/{basehead}": { "get": { "summary": "Compare two commits", - "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-cloud@latest/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], "operationId": "repos/compare-commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#compare-two-commits" }, "parameters": [ { @@ -437655,7 +444446,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -437664,7 +444455,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -440420,14 +447211,14 @@ "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", - "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks.\n- **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).\n- **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects.\n\nIf the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value _should_ be \"submodule\". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as \"submodule\".\n\nIf the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.\n\nIf the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the github.com URLs (`html_url` and `_links[\"html\"]`) will have null values.\n\n**Notes**:\n\n- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree).\n- This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the [Git Trees API](https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree).\n- Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\n- If the requested file's size is:\n - 1 MB or smaller: All features of this endpoint are supported.\n - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty\nstring and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n - Greater than 100 MB: This endpoint is not supported.", + "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks.\n- **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).\n- **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects.\n\nIf the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value _should_ be \"submodule\". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as \"submodule\".\n\nIf the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.\n\nIf the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the github.com URLs (`html_url` and `_links[\"html\"]`) will have null values.\n\n**Notes**:\n\n- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-cloud@latest/rest/git/trees#get-a-tree).\n- This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the [Git Trees API](https://docs.github.com/enterprise-cloud@latest/rest/git/trees#get-a-tree).\n- Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\n- If the requested file's size is:\n - 1 MB or smaller: All features of this endpoint are supported.\n - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty\nstring and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n - Greater than 100 MB: This endpoint is not supported.", "tags": [ "repos" ], "operationId": "repos/get-content", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-repository-content" }, "parameters": [ { @@ -441332,14 +448123,14 @@ }, "put": { "summary": "Create or update file contents", - "description": "Creates a new file or replaces an existing file in a repository.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.", + "description": "Creates a new file or replaces an existing file in a repository.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-cloud@latest/rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.", "tags": [ "repos" ], "operationId": "repos/create-or-update-file-contents", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#create-or-update-file-contents" }, "parameters": [ { @@ -442116,14 +448907,14 @@ }, "delete": { "summary": "Delete a file", - "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", + "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-cloud@latest/rest/repos/contents/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], "operationId": "repos/delete-file", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#delete-a-file" }, "parameters": [ { @@ -442605,7 +449396,7 @@ "operationId": "repos/list-contributors", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-contributors" }, "parameters": [ { @@ -442637,7 +449428,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -442646,7 +449437,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -442862,7 +449653,7 @@ "operationId": "dependabot/list-alerts-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository" }, "parameters": [ { @@ -443010,7 +449801,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -443019,7 +449810,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -443028,7 +449819,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -444502,7 +451293,7 @@ "operationId": "dependabot/get-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#get-a-dependabot-alert" }, "parameters": [ { @@ -445756,14 +452547,14 @@ }, "patch": { "summary": "Update a Dependabot alert", - "description": "The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see \"[Granting access to security alerts](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see \"[Granting access to security alerts](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "tags": [ "dependabot" ], "operationId": "dependabot/update-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#update-a-dependabot-alert" }, "parameters": [ { @@ -447201,7 +453992,7 @@ "operationId": "dependabot/list-repo-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-repository-secrets" }, "parameters": [ { @@ -447224,7 +454015,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -447233,7 +454024,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -447337,7 +454128,7 @@ "operationId": "dependabot/get-repo-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-public-key" }, "parameters": [ { @@ -447419,7 +454210,7 @@ "operationId": "dependabot/get-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-secret" }, "parameters": [ { @@ -447504,14 +454295,14 @@ }, "put": { "summary": "Create or update a repository secret", - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/create-or-update-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-a-repository-secret" }, "parameters": [ { @@ -447551,7 +454342,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -447611,7 +454402,7 @@ "operationId": "dependabot/delete-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#delete-a-repository-secret" }, "parameters": [ { @@ -447665,7 +454456,7 @@ "operationId": "dependency-graph/diff-range", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits" }, "parameters": [ { @@ -447964,7 +454755,7 @@ "operationId": "dependency-graph/export-sbom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository" }, "parameters": [ { @@ -448368,7 +455159,7 @@ "operationId": "dependency-graph/fetch-sbom-report", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository" }, "parameters": [ { @@ -448484,7 +455275,7 @@ "operationId": "dependency-graph/generate-sbom-report", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository" }, "parameters": [ { @@ -448600,7 +455391,7 @@ "operationId": "dependency-graph/create-repository-snapshot", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository" }, "parameters": [ { @@ -449004,7 +455795,7 @@ "operationId": "repos/list-deployments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#list-deployments" }, "parameters": [ { @@ -449070,7 +455861,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -449079,7 +455870,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -449882,14 +456673,14 @@ }, "post": { "summary": "Create a deployment", - "description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Cloud we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nMerged branch response:\n\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\nMerge conflict response:\n\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\nFailed commit status checks:\n\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", + "description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Cloud we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nMerged branch response:\n\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\nMerge conflict response:\n\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\nFailed commit status checks:\n\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/create-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#create-a-deployment" }, "parameters": [ { @@ -449934,7 +456725,7 @@ }, "required_contexts": { "type": "array", - "description": "The [status](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", + "description": "The [status](https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", "items": { "type": "string" } @@ -450897,7 +457688,7 @@ "operationId": "repos/get-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#get-a-deployment" }, "parameters": [ { @@ -451736,14 +458527,14 @@ }, "delete": { "summary": "Delete a deployment", - "description": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", + "description": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#create-a-deployment-status).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/delete-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#delete-a-deployment" }, "parameters": [ { @@ -451853,7 +458644,7 @@ "operationId": "repos/list-deployment-statuses", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#list-deployment-statuses" }, "parameters": [ { @@ -451885,7 +458676,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -451894,7 +458685,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -452716,7 +459507,7 @@ "operationId": "repos/create-deployment-status", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#create-a-deployment-status" }, "parameters": [ { @@ -453673,7 +460464,7 @@ "operationId": "repos/get-deployment-status", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#get-a-deployment-status" }, "parameters": [ { @@ -454515,7 +461306,7 @@ "operationId": "code-scanning/list-dismissal-requests-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/alert-dismissal-requests#list-dismissal-requests-for-code-scanning-alerts-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/alert-dismissal-requests#list-dismissal-requests-for-code-scanning-alerts-for-a-repository" }, "x-github": { "githubCloudOnly": true, @@ -454595,7 +461386,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -454604,7 +461395,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -455002,7 +461793,7 @@ "operationId": "code-scanning/get-dismissal-request-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/alert-dismissal-requests#get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/alert-dismissal-requests#get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository" }, "x-github": { "githubCloudOnly": true, @@ -455380,7 +462171,7 @@ "operationId": "code-scanning/review-dismissal-request-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/alert-dismissal-requests#review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/alert-dismissal-requests#review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository" }, "x-github": { "githubCloudOnly": true, @@ -455623,7 +462414,7 @@ "operationId": "dependabot/list-dismissal-requests-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#list-dismissal-requests-for-dependabot-alerts-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#list-dismissal-requests-for-dependabot-alerts-for-a-repository" }, "x-github": { "githubCloudOnly": true, @@ -455703,7 +462494,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -455712,7 +462503,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -456112,7 +462903,7 @@ "operationId": "dependabot/get-dismissal-request-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#get-a-dismissal-request-for-a-dependabot-alert-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#get-a-dismissal-request-for-a-dependabot-alert-for-a-repository" }, "x-github": { "githubCloudOnly": true, @@ -456481,7 +463272,7 @@ "operationId": "dependabot/create-dismissal-request-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#create-a-dismissal-request-for-a-dependabot-alert-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#create-a-dismissal-request-for-a-dependabot-alert-for-a-repository" }, "x-github": { "githubCloudOnly": true, @@ -456962,7 +463753,7 @@ "operationId": "dependabot/review-dismissal-request-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#review-a-dismissal-request-for-a-dependabot-alert-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#review-a-dismissal-request-for-a-dependabot-alert-for-a-repository" }, "x-github": { "githubCloudOnly": true, @@ -457223,7 +464014,7 @@ "operationId": "dependabot/cancel-dismissal-request-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#cancel-a-dismissal-request-for-a-dependabot-alert-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#cancel-a-dismissal-request-for-a-dependabot-alert-for-a-repository" }, "x-github": { "githubCloudOnly": true, @@ -457355,7 +464146,7 @@ "operationId": "secret-scanning/list-repo-dismissal-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-a-repository" }, "x-github": { "githubCloudOnly": true, @@ -457437,7 +464228,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -457446,7 +464237,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -457838,7 +464629,7 @@ "operationId": "secret-scanning/get-dismissal-request", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#get-an-alert-dismissal-request-for-secret-scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/alert-dismissal-requests#get-an-alert-dismissal-request-for-secret-scanning" }, "x-github": { "githubCloudOnly": true, @@ -458210,7 +465001,7 @@ "operationId": "secret-scanning/review-dismissal-request", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#review-an-alert-dismissal-request-for-secret-scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/alert-dismissal-requests#review-an-alert-dismissal-request-for-secret-scanning" }, "x-github": { "githubCloudOnly": true, @@ -458466,14 +465257,14 @@ "/repos/{owner}/{repo}/dispatches": { "post": { "summary": "Create a repository dispatch event", - "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Cloud to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Cloud to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/create-dispatch-event", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-dispatch-event" }, "parameters": [ { @@ -458657,7 +465448,7 @@ "operationId": "repos/get-all-environments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#list-environments" }, "parameters": [ { @@ -458680,7 +465471,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -458689,7 +465480,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -459463,7 +466254,7 @@ "operationId": "repos/get-environment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#get-an-environment" }, "parameters": [ { @@ -460238,7 +467029,7 @@ "operationId": "repos/create-or-update-environment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#create-or-update-an-environment" }, "parameters": [ { @@ -461142,7 +467933,7 @@ "operationId": "repos/delete-an-environment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#delete-an-environment" }, "parameters": [ { @@ -461196,7 +467987,7 @@ "operationId": "repos/list-deployment-branch-policies", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#list-deployment-branch-policies" }, "parameters": [ { @@ -461228,7 +468019,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -461237,7 +468028,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -461346,7 +468137,7 @@ "operationId": "repos/create-deployment-branch-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#create-a-deployment-branch-policy" }, "parameters": [ { @@ -461528,7 +468319,7 @@ "operationId": "repos/get-deployment-branch-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#get-a-deployment-branch-policy" }, "parameters": [ { @@ -461640,7 +468431,7 @@ "operationId": "repos/update-deployment-branch-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#update-a-deployment-branch-policy" }, "parameters": [ { @@ -461782,7 +468573,7 @@ "operationId": "repos/delete-deployment-branch-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#delete-a-deployment-branch-policy" }, "parameters": [ { @@ -461838,14 +468629,14 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": { "get": { "summary": "Get all deployment protection rules for an environment", - "description": "Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], "operationId": "repos/get-all-deployment-protection-rules", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment" }, "parameters": [ { @@ -462048,14 +468839,14 @@ }, "post": { "summary": "Create a custom deployment protection rule on an environment", - "description": "Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-cloud@latest//actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-cloud@latest/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/create-deployment-protection-rule", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment" }, "parameters": [ { @@ -462219,14 +469010,14 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { "get": { "summary": "List custom deployment rule integrations available for an environment", - "description": "Gets all custom deployment protection rule integrations that are available for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Gets all custom deployment protection rule integrations that are available for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-app)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], "operationId": "repos/list-custom-deployment-rule-integrations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment" }, "parameters": [ { @@ -462258,7 +469049,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -462267,7 +469058,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -462376,14 +469167,14 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": { "get": { "summary": "Get a custom deployment protection rule", - "description": "Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], "operationId": "repos/get-custom-deployment-protection-rule", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-a-custom-deployment-protection-rule" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule" }, "parameters": [ { @@ -462538,7 +469329,7 @@ "operationId": "repos/disable-deployment-protection-rule", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment" }, "parameters": [ { @@ -462601,7 +469392,7 @@ "operationId": "actions/list-environment-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-environment-secrets" }, "parameters": [ { @@ -462633,7 +469424,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -462642,7 +469433,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -462746,7 +469537,7 @@ "operationId": "actions/get-environment-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-public-key" }, "parameters": [ { @@ -462861,7 +469652,7 @@ "operationId": "actions/get-environment-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-secret" }, "parameters": [ { @@ -462955,14 +469746,14 @@ }, "put": { "summary": "Create or update an environment secret", - "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/create-or-update-environment-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-environment-secret" }, "parameters": [ { @@ -463011,7 +469802,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -463075,7 +469866,7 @@ "operationId": "actions/delete-environment-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-an-environment-secret" }, "parameters": [ { @@ -463138,7 +469929,7 @@ "operationId": "actions/list-environment-variables", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-environment-variables" }, "parameters": [ { @@ -463170,7 +469961,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -463179,7 +469970,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -463298,7 +470089,7 @@ "operationId": "actions/create-environment-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-an-environment-variable" }, "parameters": [ { @@ -463400,7 +470191,7 @@ "operationId": "actions/get-environment-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-an-environment-variable" }, "parameters": [ { @@ -463517,7 +470308,7 @@ "operationId": "actions/update-environment-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-an-environment-variable" }, "parameters": [ { @@ -463606,7 +470397,7 @@ "operationId": "actions/delete-environment-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-an-environment-variable" }, "parameters": [ { @@ -463669,7 +470460,7 @@ "operationId": "activity/list-repo-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-repository-events" }, "parameters": [ { @@ -463692,7 +470483,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -463701,7 +470492,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -476687,7 +483478,7 @@ "operationId": "repos/list-forks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/forks#list-forks" }, "parameters": [ { @@ -476726,7 +483517,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -476735,7 +483526,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -477910,7 +484701,7 @@ "operationId": "repos/create-fork", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/forks#create-a-fork" }, "parameters": [ { @@ -482955,7 +489746,7 @@ "operationId": "git/create-blob", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/blobs#create-a-blob" }, "parameters": [ { @@ -483259,14 +490050,14 @@ "/repos/{owner}/{repo}/git/blobs/{file_sha}": { "get": { "summary": "Get a blob", - "description": "The `content` in the response will always be Base64 encoded.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw blob data.\n- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.\n\n**Note** This endpoint supports blobs up to 100 megabytes in size.", + "description": "The `content` in the response will always be Base64 encoded.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw blob data.\n- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.\n\n**Note** This endpoint supports blobs up to 100 megabytes in size.", "tags": [ "git" ], "operationId": "git/get-blob", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/blobs#get-a-blob" }, "parameters": [ { @@ -483528,7 +490319,7 @@ "operationId": "git/create-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/commits#create-a-commit" }, "parameters": [ { @@ -484039,7 +490830,7 @@ "operationId": "git/get-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/commits#get-a-commit-object" }, "parameters": [ { @@ -484376,14 +491167,14 @@ "/repos/{owner}/{repo}/git/matching-refs/{ref}": { "get": { "summary": "List matching references", - "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", + "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", "tags": [ "git" ], "operationId": "git/list-matching-refs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/refs#list-matching-references" }, "parameters": [ { @@ -484548,14 +491339,14 @@ "/repos/{owner}/{repo}/git/ref/{ref}": { "get": { "summary": "Get a reference", - "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", + "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", "tags": [ "git" ], "operationId": "git/get-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference" }, "parameters": [ { @@ -484730,7 +491521,7 @@ "operationId": "git/create-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/refs#create-a-reference" }, "parameters": [ { @@ -484983,7 +491774,7 @@ "operationId": "git/update-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/refs#update-a-reference" }, "parameters": [ { @@ -485237,7 +492028,7 @@ "operationId": "git/delete-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/refs#delete-a-reference" }, "parameters": [ { @@ -485315,14 +492106,14 @@ "/repos/{owner}/{repo}/git/tags": { "post": { "summary": "Create a tag object", - "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], "operationId": "git/create-tag", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/tags#create-a-tag-object" }, "parameters": [ { @@ -485711,7 +492502,7 @@ "operationId": "git/get-tag", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/tags#get-a-tag" }, "parameters": [ { @@ -485967,14 +492758,14 @@ "/repos/{owner}/{repo}/git/trees": { "post": { "summary": "Create a tree", - "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit)\" and \"[Update a reference](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.", + "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/enterprise-cloud@latest/rest/git/commits#create-a-commit)\" and \"[Update a reference](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.", "tags": [ "git" ], "operationId": "git/create-tree", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/trees#create-a-tree" }, "parameters": [ { @@ -486364,7 +493155,7 @@ "operationId": "git/get-tree", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/git/trees#get-a-tree" }, "parameters": [ { @@ -486695,7 +493486,7 @@ "operationId": "repos/list-webhooks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#list-repository-webhooks" }, "parameters": [ { @@ -486718,7 +493509,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -486727,7 +493518,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -486804,7 +493595,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -486999,7 +493790,7 @@ "operationId": "repos/create-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#create-a-repository-webhook" }, "parameters": [ { @@ -487056,7 +493847,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -487079,7 +493870,7 @@ }, "events": { "type": "array", - "description": "Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) the hook is triggered for.", + "description": "Determines what [events](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads) the hook is triggered for.", "default": [ "push" ], @@ -487182,7 +493973,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -487477,7 +494268,7 @@ "operationId": "repos/get-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-repository-webhook" }, "parameters": [ { @@ -487575,7 +494366,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -487759,7 +494550,7 @@ "operationId": "repos/update-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#update-a-repository-webhook" }, "parameters": [ { @@ -487819,7 +494610,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -487842,7 +494633,7 @@ }, "events": { "type": "array", - "description": "Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", + "description": "Determines what [events](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", "default": [ "push" ], @@ -487951,7 +494742,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -488210,7 +495001,7 @@ "operationId": "repos/delete-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#delete-a-repository-webhook" }, "parameters": [ { @@ -488290,7 +495081,7 @@ "operationId": "repos/get-webhook-config-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-webhook-configuration-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository" }, "parameters": [ { @@ -488348,7 +495139,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -488399,7 +495190,7 @@ "operationId": "repos/update-webhook-config-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-webhook-configuration-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository" }, "parameters": [ { @@ -488455,7 +495246,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -488515,7 +495306,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -488568,7 +495359,7 @@ "operationId": "repos/list-webhook-deliveries", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#list-deliveries-for-a-repository-webhook" }, "parameters": [ { @@ -488600,7 +495391,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -488958,7 +495749,7 @@ "operationId": "repos/get-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-delivery-for-a-repository-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook" }, "parameters": [ { @@ -489392,7 +496183,7 @@ "operationId": "repos/redeliver-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook" }, "parameters": [ { @@ -489602,14 +496393,14 @@ "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { "post": { "summary": "Ping a repository webhook", - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-cloud@latest//webhooks/#ping-event) to be sent to the hook.", + "description": "This will trigger a [ping event](https://docs.github.com/enterprise-cloud@latest/webhooks/#ping-event) to be sent to the hook.", "tags": [ "repos" ], "operationId": "repos/ping-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#ping-a-repository-webhook" }, "parameters": [ { @@ -489689,7 +496480,7 @@ "operationId": "repos/test-push-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#test-the-push-repository-webhook" }, "parameters": [ { @@ -489769,7 +496560,7 @@ "operationId": "repos/check-immutable-releases", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository" }, "parameters": [ { @@ -489852,7 +496643,7 @@ "operationId": "repos/enable-immutable-releases", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-immutable-releases" }, "parameters": [ { @@ -489921,7 +496712,7 @@ "operationId": "repos/disable-immutable-releases", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-immutable-releases" }, "parameters": [ { @@ -489985,14 +496776,14 @@ "/repos/{owner}/{repo}/import": { "get": { "summary": "Get an import status", - "description": "View the progress of an import.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub Enterprise Cloud. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub Enterprise Cloud.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.", + "description": "View the progress of an import.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub Enterprise Cloud. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub Enterprise Cloud.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.", "tags": [ "migrations" ], "operationId": "migrations/get-import-status", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-an-import-status" }, "parameters": [ { @@ -490259,7 +497050,7 @@ "operationId": "migrations/start-import", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#start-an-import" }, "parameters": [ { @@ -490661,7 +497452,7 @@ "operationId": "migrations/update-import", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import" }, "parameters": [ { @@ -491000,7 +497791,7 @@ "operationId": "migrations/cancel-import", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#cancel-an-import" }, "parameters": [ { @@ -491067,14 +497858,14 @@ "/repos/{owner}/{repo}/import/authors": { "get": { "summary": "Get commit authors", - "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", + "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "tags": [ "migrations" ], "operationId": "migrations/get-commit-authors", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-commit-authors" }, "parameters": [ { @@ -491262,7 +498053,7 @@ "operationId": "migrations/map-commit-author", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#map-a-commit-author" }, "parameters": [ { @@ -491530,7 +498321,7 @@ "operationId": "migrations/get-large-files", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-large-files" }, "parameters": [ { @@ -491653,14 +498444,14 @@ "/repos/{owner}/{repo}/import/lfs": { "patch": { "summary": "Update Git LFS preference", - "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/enterprise-cloud@latest//repositories/working-with-files/managing-large-files).\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", + "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/enterprise-cloud@latest/repositories/working-with-files/managing-large-files).\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "tags": [ "migrations" ], "operationId": "migrations/set-lfs-preference", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-git-lfs-preference" }, "parameters": [ { @@ -492001,14 +498792,14 @@ "/repos/{owner}/{repo}/installation": { "get": { "summary": "Get a repository installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-repo-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-repository-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app" }, "parameters": [ { @@ -492643,7 +499434,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -493210,7 +500001,7 @@ "operationId": "interactions/get-restrictions-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#get-interaction-restrictions-for-a-repository" }, "parameters": [ { @@ -493312,7 +500103,7 @@ "operationId": "interactions/set-restrictions-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#set-interaction-restrictions-for-a-repository" }, "parameters": [ { @@ -493460,7 +500251,7 @@ "operationId": "interactions/remove-restrictions-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#remove-interaction-restrictions-for-a-repository" }, "parameters": [ { @@ -493508,7 +500299,7 @@ "operationId": "repos/list-invitations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#list-repository-invitations" }, "parameters": [ { @@ -493531,7 +500322,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -493540,7 +500331,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -495069,7 +501860,7 @@ "operationId": "repos/update-invitation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#update-a-repository-invitation" }, "parameters": [ { @@ -496638,7 +503429,7 @@ "operationId": "repos/delete-invitation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#delete-a-repository-invitation" }, "parameters": [ { @@ -496685,14 +503476,14 @@ "/repos/{owner}/{repo}/issues": { "get": { "summary": "List repository issues", - "description": "List issues in a repository. Only open issues will be listed.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues in a repository. Only open issues will be listed.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-repository-issues" }, "parameters": [ { @@ -496823,7 +503614,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -496832,7 +503623,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -501022,14 +507813,14 @@ }, "post": { "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-cloud@latest//articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-cloud@latest/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#create-an-issue" }, "parameters": [ { @@ -505465,14 +512256,14 @@ "/repos/{owner}/{repo}/issues/comments": { "get": { "summary": "List issue comments for a repository", - "description": "You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-comments-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#list-issue-comments-for-a-repository" }, "parameters": [ { @@ -505532,7 +512323,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -505541,7 +512332,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -506639,14 +513430,14 @@ "/repos/{owner}/{repo}/issues/comments/{comment_id}": { "get": { "summary": "Get an issue comment", - "description": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/get-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment" }, "parameters": [ { @@ -507679,14 +514470,14 @@ }, "patch": { "summary": "Update an issue comment", - "description": "You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/update-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#update-an-issue-comment" }, "parameters": [ { @@ -508801,7 +515592,7 @@ "operationId": "issues/delete-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#delete-an-issue-comment" }, "parameters": [ { @@ -508849,14 +515640,14 @@ "/repos/{owner}/{repo}/issues/comments/{comment_id}/pin": { "put": { "summary": "Pin an issue comment", - "description": "You can use the REST API to pin comments on issues.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to pin comments on issues.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/pin-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#pin-an-issue-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#pin-an-issue-comment" }, "parameters": [ { @@ -510071,7 +516862,7 @@ "operationId": "issues/unpin-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#unpin-an-issue-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#unpin-an-issue-comment" }, "parameters": [ { @@ -510244,14 +517035,14 @@ "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { "get": { "summary": "List reactions for an issue comment", - "description": "List the reactions to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment).", + "description": "List the reactions to an [issue comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment).", "tags": [ "reactions" ], "operationId": "reactions/list-for-issue-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-an-issue-comment" }, "parameters": [ { @@ -510284,7 +517075,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment.", "in": "query", "required": false, "schema": { @@ -510303,7 +517094,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -510312,7 +517103,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -510632,14 +517423,14 @@ }, "post": { "summary": "Create reaction for an issue comment", - "description": "Create a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.", + "description": "Create a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.", "tags": [ "reactions" ], "operationId": "reactions/create-for-issue-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-an-issue-comment" }, "parameters": [ { @@ -510680,7 +517471,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the issue comment.", + "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions) to add to the issue comment.", "enum": [ "+1", "-1", @@ -511319,14 +518110,14 @@ "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete an issue comment reaction", - "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-issue-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-an-issue-comment-reaction" }, "parameters": [ { @@ -511390,7 +518181,7 @@ "operationId": "issues/list-events-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/events#list-issue-events-for-a-repository" }, "parameters": [ { @@ -511413,7 +518204,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -511422,7 +518213,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -517332,7 +524123,7 @@ "operationId": "issues/get-event", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/events#get-an-issue-event" }, "parameters": [ { @@ -523286,14 +530077,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}": { "get": { "summary": "Get an issue", - "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-cloud@latest//articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#issues) webhook.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-cloud@latest/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#issues) webhook.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue" }, "parameters": [ { @@ -527667,14 +534458,14 @@ }, "patch": { "summary": "Update an issue", - "description": "Issue owners and users with push access or Triage role can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Issue owners and users with push access or Triage role can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#update-an-issue" }, "parameters": [ { @@ -532135,7 +538926,7 @@ "operationId": "issues/add-assignees", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#add-assignees-to-an-issue" }, "parameters": [ { @@ -536244,7 +543035,7 @@ "operationId": "issues/remove-assignees", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#remove-assignees-from-an-issue" }, "parameters": [ { @@ -540354,7 +547145,7 @@ "operationId": "issues/check-user-can-be-assigned-to-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue" }, "parameters": [ { @@ -540435,14 +547226,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/comments": { "get": { "summary": "List issue comments", - "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-comments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#list-issue-comments" }, "parameters": [ { @@ -540484,7 +547275,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -540493,7 +547284,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -541540,14 +548331,14 @@ }, "post": { "summary": "Create an issue comment", - "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/create-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#create-an-issue-comment" }, "parameters": [ { @@ -542743,14 +549534,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": { "get": { "summary": "List dependencies an issue is blocked by", - "description": "You can use the REST API to list the dependencies an issue is blocked by.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to list the dependencies an issue is blocked by.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-dependencies-blocked-by", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by" }, "parameters": [ { @@ -542782,7 +549573,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -542791,7 +549582,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -546932,14 +553723,14 @@ }, "post": { "summary": "Add a dependency an issue is blocked by", - "description": "You can use the REST API to add a 'blocked by' relationship to an issue.\n\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to add a 'blocked by' relationship to an issue.\n\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/add-blocked-by-dependency", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by" }, "parameters": [ { @@ -551228,14 +558019,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": { "delete": { "summary": "Remove dependency an issue is blocked by", - "description": "You can use the REST API to remove a dependency that an issue is blocked by.\n\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to remove a dependency that an issue is blocked by.\n\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/remove-dependency-blocked-by", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by" }, "parameters": [ { @@ -555518,14 +562309,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": { "get": { "summary": "List dependencies an issue is blocking", - "description": "You can use the REST API to list the dependencies an issue is blocking.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to list the dependencies an issue is blocking.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-dependencies-blocking", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking" }, "parameters": [ { @@ -555557,7 +562348,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -555566,7 +562357,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -559716,7 +566507,7 @@ "operationId": "issues/list-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/events#list-issue-events" }, "parameters": [ { @@ -559748,7 +566539,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -559757,7 +566548,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -571274,7 +578065,7 @@ "operationId": "issues/list-issue-field-values-for-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#list-issue-field-values-for-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#list-issue-field-values-for-an-issue" }, "parameters": [ { @@ -571306,7 +578097,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -571315,7 +578106,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -571570,14 +578361,14 @@ }, "post": { "summary": "Add issue field values to an issue", - "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "issues" ], "operationId": "issues/add-issue-field-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#add-issue-field-values-to-an-issue" }, "parameters": [ { @@ -572069,14 +578860,14 @@ }, "put": { "summary": "Set issue field values for an issue", - "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "issues" ], "operationId": "issues/set-issue-field-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#set-issue-field-values-for-an-issue" }, "parameters": [ { @@ -572570,14 +579361,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": { "delete": { "summary": "Delete an issue field value from an issue", - "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "issues" ], "operationId": "issues/delete-issue-field-value", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" }, "parameters": [ { @@ -572789,7 +579580,7 @@ "operationId": "issues/list-labels-on-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-an-issue" }, "parameters": [ { @@ -572821,7 +579612,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -572830,7 +579621,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -573045,7 +579836,7 @@ "operationId": "issues/add-labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#add-labels-to-an-issue" }, "parameters": [ { @@ -573088,7 +579879,7 @@ "labels": { "type": "array", "minItems": 1, - "description": "The names of the labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use \"[Set labels for an issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue).\"", + "description": "The names of the labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use \"[Set labels for an issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#set-labels-for-an-issue).\"", "items": { "type": "string" } @@ -573404,7 +580195,7 @@ "operationId": "issues/set-labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#set-labels-for-an-issue" }, "parameters": [ { @@ -573447,7 +580238,7 @@ "labels": { "type": "array", "minItems": 1, - "description": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue).\"", + "description": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#add-labels-to-an-issue).\"", "items": { "type": "string" } @@ -573788,7 +580579,7 @@ "operationId": "issues/remove-all-labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#remove-all-labels-from-an-issue" }, "parameters": [ { @@ -573920,7 +580711,7 @@ "operationId": "issues/remove-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#remove-a-label-from-an-issue" }, "parameters": [ { @@ -574144,14 +580935,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/lock": { "put": { "summary": "Lock an issue", - "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "issues" ], "operationId": "issues/lock", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#lock-an-issue" }, "parameters": [ { @@ -574389,7 +581180,7 @@ "operationId": "issues/unlock", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#unlock-an-issue" }, "parameters": [ { @@ -574488,14 +581279,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/parent": { "get": { "summary": "Get parent issue", - "description": "You can use the REST API to get the parent issue of a sub-issue.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to get the parent issue of a sub-issue.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/get-parent", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#get-parent-issue" }, "parameters": [ { @@ -578648,14 +585439,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { "get": { "summary": "List reactions for an issue", - "description": "List the reactions to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue).", + "description": "List the reactions to an [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue).", "tags": [ "reactions" ], "operationId": "reactions/list-for-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-an-issue" }, "parameters": [ { @@ -578687,7 +585478,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue.", "in": "query", "required": false, "schema": { @@ -578706,7 +585497,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -578715,7 +585506,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -579061,14 +585852,14 @@ }, "post": { "summary": "Create reaction for an issue", - "description": "Create a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue.", + "description": "Create a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue.", "tags": [ "reactions" ], "operationId": "reactions/create-for-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-an-issue" }, "parameters": [ { @@ -579108,7 +585899,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the issue.", + "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions) to add to the issue.", "enum": [ "+1", "-1", @@ -579747,14 +586538,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { "delete": { "summary": "Delete an issue reaction", - "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-an-issue-reaction" }, "parameters": [ { @@ -579810,14 +586601,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": { "delete": { "summary": "Remove sub-issue", - "description": "You can use the REST API to remove a sub-issue from an issue.\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to remove a sub-issue from an issue.\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/remove-sub-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#remove-sub-issue" }, "parameters": [ { @@ -584021,14 +590812,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": { "get": { "summary": "List sub-issues", - "description": "You can use the REST API to list the sub-issues on an issue.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to list the sub-issues on an issue.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-sub-issues", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#list-sub-issues" }, "parameters": [ { @@ -584060,7 +590851,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -584069,7 +590860,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -588184,14 +594975,14 @@ }, "post": { "summary": "Add sub-issue", - "description": "You can use the REST API to add sub-issues to issues.\n\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to add sub-issues to issues.\n\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/add-sub-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#add-sub-issue" }, "parameters": [ { @@ -592464,7 +599255,7 @@ "operationId": "issues/reprioritize-sub-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#reprioritize-sub-issue" }, "parameters": [ { @@ -596685,7 +603476,7 @@ "operationId": "issues/list-events-for-timeline", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/timeline#list-timeline-events-for-an-issue" }, "parameters": [ { @@ -596717,7 +603508,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -596726,7 +603517,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -615210,7 +622001,7 @@ "operationId": "repos/list-deploy-keys", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#list-deploy-keys" }, "parameters": [ { @@ -615233,7 +622024,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -615242,7 +622033,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -615357,7 +622148,7 @@ "operationId": "repos/create-deploy-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#create-a-deploy-key" }, "parameters": [ { @@ -615396,7 +622187,7 @@ }, "read_only": { "type": "boolean", - "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-cloud@latest//articles/permission-levels-for-a-user-account-repository/).\"" + "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-cloud@latest/articles/permission-levels-for-a-user-account-repository/).\"" } }, "required": [ @@ -615594,7 +622385,7 @@ "operationId": "repos/get-deploy-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key" }, "parameters": [ { @@ -615745,7 +622536,7 @@ "operationId": "repos/delete-deploy-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#delete-a-deploy-key" }, "parameters": [ { @@ -615799,7 +622590,7 @@ "operationId": "issues/list-labels-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-a-repository" }, "parameters": [ { @@ -615822,7 +622613,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -615831,7 +622622,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -615994,7 +622785,7 @@ "operationId": "issues/create-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#create-a-label" }, "parameters": [ { @@ -616270,7 +623061,7 @@ "operationId": "issues/get-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#get-a-label" }, "parameters": [ { @@ -616433,7 +623224,7 @@ "operationId": "issues/update-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#update-a-label" }, "parameters": [ { @@ -616603,7 +623394,7 @@ "operationId": "issues/delete-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#delete-a-label" }, "parameters": [ { @@ -616656,7 +623447,7 @@ "operationId": "repos/list-languages", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-languages" }, "parameters": [ { @@ -616721,7 +623512,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/lfs#enable-git-lfs-for-a-repository" }, "parameters": [ { @@ -616779,7 +623570,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/lfs#disable-git-lfs-for-a-repository" }, "parameters": [ { @@ -616817,14 +623608,14 @@ "/repos/{owner}/{repo}/license": { "get": { "summary": "Get the license for a repository", - "description": "This method returns the contents of the repository's license file, if one is detected.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw contents of the license.\n- **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", + "description": "This method returns the contents of the repository's license file, if one is detected.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw contents of the license.\n- **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", "tags": [ "licenses" ], "operationId": "licenses/get-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/licenses/licenses#get-the-license-for-a-repository" }, "parameters": [ { @@ -617096,7 +623887,7 @@ "operationId": "repos/merge-upstream", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository" }, "parameters": [ { @@ -617207,7 +623998,7 @@ "operationId": "repos/merge", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#merge-a-branch" }, "parameters": [ { @@ -618225,7 +625016,7 @@ "operationId": "issues/list-milestones", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#list-milestones" }, "parameters": [ { @@ -618291,7 +625082,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -618300,7 +625091,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -618727,7 +625518,7 @@ "operationId": "issues/create-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#create-a-milestone" }, "parameters": [ { @@ -619287,7 +626078,7 @@ "operationId": "issues/get-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#get-a-milestone" }, "parameters": [ { @@ -619724,7 +626515,7 @@ "operationId": "issues/update-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#update-a-milestone" }, "parameters": [ { @@ -620179,7 +626970,7 @@ "operationId": "issues/delete-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#delete-a-milestone" }, "parameters": [ { @@ -620259,7 +627050,7 @@ "operationId": "issues/list-labels-for-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-issues-in-a-milestone" }, "parameters": [ { @@ -620291,7 +627082,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -620300,7 +627091,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -620439,7 +627230,7 @@ "operationId": "activity/list-repo-notifications-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user" }, "parameters": [ { @@ -620502,7 +627293,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -620511,7 +627302,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -621649,14 +628440,14 @@ }, "put": { "summary": "Mark repository notifications as read", - "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], "operationId": "activity/mark-repo-notifications-as-read", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-repository-notifications-as-read" }, "parameters": [ { @@ -621750,7 +628541,7 @@ "operationId": "repos/get-pages", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-a-apiname-pages-site" }, "parameters": [ { @@ -622035,7 +628826,7 @@ "operationId": "repos/create-pages-site", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#create-a-apiname-pages-site" }, "parameters": [ { @@ -622463,7 +629254,7 @@ "operationId": "repos/update-information-about-pages-site", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#update-information-about-a-apiname-pages-site" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#update-information-about-a-apiname-pages-site" }, "parameters": [ { @@ -622497,7 +629288,7 @@ "string", "null" ], - "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-cloud@latest//pages/configuring-a-custom-domain-for-your-github-pages-site).\"" + "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-cloud@latest/pages/configuring-a-custom-domain-for-your-github-pages-site).\"" }, "https_enforced": { "type": "boolean", @@ -622783,7 +629574,7 @@ "operationId": "repos/delete-pages-site", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#delete-a-apiname-pages-site" }, "parameters": [ { @@ -622955,7 +629746,7 @@ "operationId": "repos/list-pages-builds", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#list-apiname-pages-builds" }, "parameters": [ { @@ -622978,7 +629769,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -622987,7 +629778,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -623295,7 +630086,7 @@ "operationId": "repos/request-pages-build", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#request-a-apiname-pages-build" }, "parameters": [ { @@ -623376,7 +630167,7 @@ "operationId": "repos/get-latest-pages-build", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-latest-pages-build" }, "parameters": [ { @@ -623687,7 +630478,7 @@ "operationId": "repos/get-pages-build", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-apiname-pages-build" }, "parameters": [ { @@ -624006,7 +630797,7 @@ "operationId": "repos/create-pages-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#create-a-github-pages-deployment" }, "parameters": [ { @@ -624329,7 +631120,7 @@ "operationId": "repos/get-pages-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-the-status-of-a-github-pages-deployment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-the-status-of-a-github-pages-deployment" }, "parameters": [ { @@ -624450,7 +631241,7 @@ "operationId": "repos/cancel-pages-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#cancel-a-github-pages-deployment" }, "parameters": [ { @@ -624537,7 +631328,7 @@ "operationId": "repos/get-pages-health-check", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-dns-health-check-for-github-pages" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-a-dns-health-check-for-github-pages" }, "parameters": [ { @@ -624992,14 +631783,14 @@ "/repos/{owner}/{repo}/private-vulnerability-reporting": { "get": { "summary": "Check if private vulnerability reporting is enabled for a repository", - "description": "Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"[Evaluating the security settings of a repository](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".", + "description": "Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"[Evaluating the security settings of a repository](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".", "tags": [ "repos" ], "operationId": "repos/check-private-vulnerability-reporting", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository" }, "parameters": [ { @@ -625126,14 +631917,14 @@ }, "put": { "summary": "Enable private vulnerability reporting for a repository", - "description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"", + "description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"", "tags": [ "repos" ], "operationId": "repos/enable-private-vulnerability-reporting", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository" }, "parameters": [ { @@ -625237,14 +632028,14 @@ }, "delete": { "summary": "Disable private vulnerability reporting for a repository", - "description": "Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\".", + "description": "Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\".", "tags": [ "repos" ], "operationId": "repos/disable-private-vulnerability-reporting", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository" }, "parameters": [ { @@ -625357,7 +632148,7 @@ "operationId": "repos/custom-properties-for-repos-get-repository-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#get-all-custom-property-values-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository" }, "parameters": [ { @@ -625511,7 +632302,7 @@ "operationId": "repos/custom-properties-for-repos-create-or-update-repository-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository" }, "parameters": [ { @@ -625749,14 +632540,14 @@ "/repos/{owner}/{repo}/pulls": { "get": { "summary": "List pull requests", - "description": "Lists pull requests in a specified repository.\n\nDraft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\nin the GitHub Help documentation.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists pull requests in a specified repository.\n\nDraft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products)\nin the GitHub Help documentation.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests" }, "parameters": [ { @@ -625841,7 +632632,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -625850,7 +632641,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -630681,14 +637472,14 @@ }, "post": { "summary": "Create a pull request", - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#create-a-pull-request" }, "parameters": [ { @@ -630743,11 +637534,11 @@ }, "maintainer_can_modify": { "type": "boolean", - "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-cloud@latest//articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." + "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-cloud@latest/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." }, "draft": { "type": "boolean", - "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/enterprise-cloud@latest//articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more." + "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/enterprise-cloud@latest/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more." }, "issue": { "type": "integer", @@ -635760,14 +642551,14 @@ "/repos/{owner}/{repo}/pulls/comments": { "get": { "summary": "List review comments in a repository", - "description": "Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-review-comments-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#list-review-comments-in-a-repository" }, "parameters": [ { @@ -635826,7 +642617,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -635835,7 +642626,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -636453,14 +643244,14 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { "get": { "summary": "Get a review comment for a pull request", - "description": "Provides details for a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Provides details for a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/get-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request" }, "parameters": [ { @@ -637113,14 +643904,14 @@ }, "patch": { "summary": "Update a review comment for a pull request", - "description": "Edits the content of a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Edits the content of a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/update-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#update-a-review-comment-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#update-a-review-comment-for-a-pull-request" }, "parameters": [ { @@ -637780,7 +644571,7 @@ "operationId": "pulls/delete-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#delete-a-review-comment-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#delete-a-review-comment-for-a-pull-request" }, "parameters": [ { @@ -637854,14 +644645,14 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { "get": { "summary": "List reactions for a pull request review comment", - "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request).", + "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "tags": [ "reactions" ], "operationId": "reactions/list-for-pull-request-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment" }, "parameters": [ { @@ -637894,7 +644685,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment.", "in": "query", "required": false, "schema": { @@ -637913,7 +644704,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -637922,7 +644713,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -638242,14 +645033,14 @@ }, "post": { "summary": "Create reaction for a pull request review comment", - "description": "Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.", + "description": "Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.", "tags": [ "reactions" ], "operationId": "reactions/create-for-pull-request-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment" }, "parameters": [ { @@ -638290,7 +645081,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the pull request review comment.", + "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions) to add to the pull request review comment.", "enum": [ "+1", "-1", @@ -638929,14 +645720,14 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a pull request comment reaction", - "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-pull-request-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-pull-request-comment-reaction" }, "parameters": [ { @@ -638993,14 +645784,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}": { "get": { "summary": "Get a pull request", - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/enterprise-cloud@latest/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/enterprise-cloud@latest/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/enterprise-cloud@latest/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", "tags": [ "pulls" ], "operationId": "pulls/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#get-a-pull-request" }, "parameters": [ { @@ -639033,7 +645824,7 @@ ], "responses": { "200": { - "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.", + "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.", "content": { "application/json": { "schema": { @@ -644005,14 +650796,14 @@ }, "patch": { "summary": "Update a pull request", - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request" }, "parameters": [ { @@ -644072,7 +650863,7 @@ }, "maintainer_can_modify": { "type": "boolean", - "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-cloud@latest//articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." + "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-cloud@latest/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." } } }, @@ -649071,7 +655862,7 @@ "operationId": "pulls/archive", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#archive-a-pull-request" }, "parameters": [ { @@ -649250,7 +656041,7 @@ "operationId": "pulls/unarchive", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#unarchive-a-pull-request" }, "parameters": [ { @@ -649431,7 +656222,7 @@ "operationId": "codespaces/create-with-pr-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request" }, "parameters": [ { @@ -653289,14 +660080,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { "get": { "summary": "List review comments on a pull request", - "description": "Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-review-comments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#list-review-comments-on-a-pull-request" }, "parameters": [ { @@ -653365,7 +660156,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -653374,7 +660165,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -653990,14 +660781,14 @@ }, "post": { "summary": "Create a review comment for a pull request", - "description": "Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment).\"\n\nIf your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.\n\nThe `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#create-an-issue-comment).\"\n\nIf your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.\n\nThe `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/create-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-review-comment-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#create-a-review-comment-for-a-pull-request" }, "parameters": [ { @@ -654057,7 +660848,7 @@ }, "side": { "type": "string", - "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/enterprise-cloud@latest//articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/enterprise-cloud@latest/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", "enum": [ "LEFT", "RIGHT" @@ -654069,11 +660860,11 @@ }, "start_line": { "type": "integer", - "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." + "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." }, "start_side": { "type": "string", - "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "enum": [ "LEFT", "RIGHT", @@ -654826,14 +661617,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { "post": { "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/create-reply-for-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#create-a-reply-for-a-review-comment" }, "parameters": [ { @@ -655532,14 +662323,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { "get": { "summary": "List commits on a pull request", - "description": "Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits)\nendpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-commits)\nendpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-commits-on-a-pull-request" }, "parameters": [ { @@ -655571,7 +662362,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -655580,7 +662371,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -656426,14 +663217,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/files": { "get": { "summary": "List pull requests files", - "description": "Lists the files in a specified pull request.\n\n> [!NOTE]\n> Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists the files in a specified pull request.\n\n> [!NOTE]\n> Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-files", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests-files" }, "parameters": [ { @@ -656465,7 +663256,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -656474,7 +663265,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -656759,7 +663550,7 @@ "operationId": "pulls/check-if-merged", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#check-if-a-pull-request-has-been-merged" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#check-if-a-pull-request-has-been-merged" }, "parameters": [ { @@ -656807,14 +663598,14 @@ }, "put": { "summary": "Merge a pull request", - "description": "Merges a pull request into the base branch.\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Merges a pull request into the base branch.\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "pulls" ], "operationId": "pulls/merge", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#merge-a-pull-request" }, "parameters": [ { @@ -657117,14 +663908,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { "get": { "summary": "Get all requested reviewers for a pull request", - "description": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", + "description": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", "tags": [ "pulls" ], "operationId": "pulls/list-requested-reviewers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request" }, "parameters": [ { @@ -657667,14 +664458,14 @@ }, "post": { "summary": "Request reviewers for a pull request", - "description": "Requests reviews for a pull request from a given set of users and/or teams.\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Requests reviews for a pull request from a given set of users and/or teams.\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "pulls" ], "operationId": "pulls/request-reviewers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#request-reviewers-for-a-pull-request" }, "parameters": [ { @@ -662566,7 +669357,7 @@ "operationId": "pulls/remove-requested-reviewers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request" }, "parameters": [ { @@ -667449,14 +674240,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { "get": { "summary": "List reviews for a pull request", - "description": "Lists all reviews for a specified pull request. The list of reviews returns in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists all reviews for a specified pull request. The list of reviews returns in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-reviews", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-reviews-for-a-pull-request" }, "parameters": [ { @@ -667488,7 +674279,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -667497,7 +674288,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -667883,14 +674674,14 @@ }, "post": { "summary": "Create a review for a pull request", - "description": "Creates a review on a specified pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n> [!NOTE]\n> To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a review on a specified pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n> [!NOTE]\n> To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/create-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#create-a-review-for-a-pull-request" }, "parameters": [ { @@ -667938,7 +674729,7 @@ }, "event": { "type": "string", - "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.", + "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.", "enum": [ "APPROVE", "REQUEST_CHANGES", @@ -668439,14 +675230,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { "get": { "summary": "Get a review for a pull request", - "description": "Retrieves a pull request review by its ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Retrieves a pull request review by its ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/get-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#get-a-review-for-a-pull-request" }, "parameters": [ { @@ -668877,14 +675668,14 @@ }, "put": { "summary": "Update a review for a pull request", - "description": "Updates the contents of a specified review summary comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Updates the contents of a specified review summary comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/update-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#update-a-review-for-a-pull-request" }, "parameters": [ { @@ -669345,14 +676136,14 @@ }, "delete": { "summary": "Delete a pending review for a pull request", - "description": "Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/delete-pending-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#delete-a-pending-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request" }, "parameters": [ { @@ -669815,14 +676606,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { "get": { "summary": "List comments for a pull request review", - "description": "Lists comments for a specific pull request review.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists comments for a specific pull request review.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-comments-for-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-comments-for-a-pull-request-review" }, "parameters": [ { @@ -669863,7 +676654,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -669872,7 +676663,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -670490,14 +677281,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { "put": { "summary": "Dismiss a review for a pull request", - "description": "Dismisses a specified review on a pull request.\n\n> [!NOTE]\n> To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Dismisses a specified review on a pull request.\n\n> [!NOTE]\n> To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/dismiss-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#dismiss-a-review-for-a-pull-request" }, "parameters": [ { @@ -670996,14 +677787,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { "post": { "summary": "Submit a review for a pull request", - "description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#create-a-review-for-a-pull-request).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/submit-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#submit-a-review-for-a-pull-request" }, "parameters": [ { @@ -671535,7 +678326,7 @@ "operationId": "pulls/update-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request-branch" }, "parameters": [ { @@ -671578,7 +678369,7 @@ "properties": { "expected_head_sha": { "type": "string", - "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref." + "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref." } } }, @@ -671732,14 +678523,14 @@ "/repos/{owner}/{repo}/readme": { "get": { "summary": "Get a repository README", - "description": "Gets the preferred README for a repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", + "description": "Gets the preferred README for a repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", "tags": [ "repos" ], "operationId": "repos/get-readme", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-a-repository-readme" }, "parameters": [ { @@ -672026,14 +678817,14 @@ "/repos/{owner}/{repo}/readme/{dir}": { "get": { "summary": "Get a repository README for a directory", - "description": "Gets the README from a repository directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", + "description": "Gets the README from a repository directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", "tags": [ "repos" ], "operationId": "repos/get-readme-in-directory", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme-for-a-directory" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-a-repository-readme-for-a-directory" }, "parameters": [ { @@ -672327,14 +679118,14 @@ "/repos/{owner}/{repo}/releases": { "get": { "summary": "List releases", - "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.", + "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.", "tags": [ "repos" ], "operationId": "repos/list-releases", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#list-releases" }, "parameters": [ { @@ -672357,7 +679148,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -672366,7 +679157,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -673127,14 +679918,14 @@ }, "post": { "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "repos" ], "operationId": "repos/create-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#create-a-release" }, "parameters": [ { @@ -673191,7 +679982,7 @@ }, "discussion_category_name": { "type": "string", - "description": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/enterprise-cloud@latest//discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\"" + "description": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/enterprise-cloud@latest/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\"" }, "generate_release_notes": { "type": "boolean", @@ -674056,14 +680847,14 @@ "/repos/{owner}/{repo}/releases/assets/{asset_id}": { "get": { "summary": "Get a release asset", - "description": "To download the asset's binary content:\n\n- If within a browser, fetch the location specified in the `browser_download_url` key provided in the response.\n- Alternatively, set the `Accept` header of the request to \n [`application/octet-stream`](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). \n The API will either redirect the client to the location, or stream it directly if possible.\n API clients should handle both a `200` or `302` response.", + "description": "To download the asset's binary content:\n\n- If within a browser, fetch the location specified in the `browser_download_url` key provided in the response.\n- Alternatively, set the `Accept` header of the request to \n [`application/octet-stream`](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). \n The API will either redirect the client to the location, or stream it directly if possible.\n API clients should handle both a `200` or `302` response.", "tags": [ "repos" ], "operationId": "repos/get-release-asset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#get-a-release-asset" }, "parameters": [ { @@ -674443,7 +681234,7 @@ "operationId": "repos/update-release-asset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#update-a-release-asset" }, "parameters": [ { @@ -674828,7 +681619,7 @@ "operationId": "repos/delete-release-asset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#delete-a-release-asset" }, "parameters": [ { @@ -674901,14 +681692,14 @@ "/repos/{owner}/{repo}/releases/generate-notes": { "post": { "summary": "Generate release notes content for a release", - "description": "Generate a name and body describing a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.", + "description": "Generate a name and body describing a [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.", "tags": [ "repos" ], "operationId": "repos/generate-release-notes", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#generate-release-notes-content-for-a-release" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#generate-release-notes-content-for-a-release" }, "parameters": [ { @@ -675054,7 +681845,7 @@ "operationId": "repos/get-latest-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-the-latest-release" }, "parameters": [ { @@ -675826,7 +682617,7 @@ "operationId": "repos/get-release-by-tag", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release-by-tag-name" }, "parameters": [ { @@ -676601,14 +683392,14 @@ "/repos/{owner}/{repo}/releases/{release_id}": { "get": { "summary": "Get a release", - "description": "Gets a public release with the specified release ID.\n\n> [!NOTE]\n> This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", + "description": "Gets a public release with the specified release ID.\n\n> [!NOTE]\n> This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", "tags": [ "repos" ], "operationId": "repos/get-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release" }, "parameters": [ { @@ -676641,7 +683432,7 @@ ], "responses": { "200": { - "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", + "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", "content": { "application/json": { "schema": { @@ -677364,7 +684155,7 @@ "operationId": "repos/update-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#update-a-release" }, "parameters": [ { @@ -677438,7 +684229,7 @@ }, "discussion_category_name": { "type": "string", - "description": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/enterprise-cloud@latest//discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\"" + "description": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/enterprise-cloud@latest/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\"" } } }, @@ -678205,7 +684996,7 @@ "operationId": "repos/delete-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#delete-a-release" }, "parameters": [ { @@ -678285,7 +685076,7 @@ "operationId": "repos/list-release-assets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#list-release-assets" }, "parameters": [ { @@ -678317,7 +685108,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -678326,7 +685117,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -678660,14 +685451,14 @@ }, "post": { "summary": "Upload a release asset", - "description": "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: \n\n`application/zip`\n\nGitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.\n\nWhen an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.\n\n**Notes:**\n* GitHub Enterprise Cloud renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List release assets](https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release). \n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.", + "description": "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: \n\n`application/zip`\n\nGitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.\n\nWhen an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.\n\n**Notes:**\n* GitHub Enterprise Cloud renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List release assets](https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#list-release-assets)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-the-latest-release). \n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.", "tags": [ "repos" ], "operationId": "repos/upload-release-asset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#upload-a-release-asset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#upload-a-release-asset" }, "servers": [ { @@ -679054,14 +685845,14 @@ "/repos/{owner}/{repo}/releases/{release_id}/reactions": { "get": { "summary": "List reactions for a release", - "description": "List the reactions to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release).", + "description": "List the reactions to a [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release).", "tags": [ "reactions" ], "operationId": "reactions/list-for-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-release" }, "parameters": [ { @@ -679093,7 +685884,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release.", "in": "query", "required": false, "schema": { @@ -679110,7 +685901,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -679119,7 +685910,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -679439,14 +686230,14 @@ }, "post": { "summary": "Create reaction for a release", - "description": "Create a reaction to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.", + "description": "Create a reaction to a [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.", "tags": [ "reactions" ], "operationId": "reactions/create-for-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-release" }, "parameters": [ { @@ -679486,7 +686277,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the release.", + "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions) to add to the release.", "enum": [ "+1", "laugh", @@ -680123,14 +686914,14 @@ "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a release reaction", - "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-release-reaction" }, "parameters": [ { @@ -680193,7 +686984,7 @@ "operationId": "repos/get-branch-rules", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-rules-for-a-branch" }, "parameters": [ { @@ -680216,7 +687007,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql).", "in": "path", "required": true, "schema": { @@ -680226,7 +687017,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -680235,7 +687026,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -681602,7 +688393,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -681612,7 +688403,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -681770,7 +688561,7 @@ "operationId": "repos/get-repo-rulesets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-all-repository-rulesets" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-all-repository-rulesets" }, "x-github": { "githubCloudOnly": false, @@ -681799,7 +688590,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -681808,7 +688599,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -681912,7 +688703,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -681922,7 +688713,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -683088,7 +689880,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -683098,7 +689890,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -683277,7 +690069,7 @@ "operationId": "repos/create-repo-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#create-a-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#create-a-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -683352,7 +690144,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -683362,7 +690154,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -684238,7 +691031,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -684248,7 +691041,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -684425,7 +691218,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -684435,7 +691228,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -685601,7 +692395,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -685611,7 +692405,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -685867,14 +692661,14 @@ "/repos/{owner}/{repo}/rulesets/rule-suites": { "get": { "summary": "List repository rule suites", - "description": "Lists suites of rule evaluations at the repository level.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"", + "description": "Lists suites of rule evaluations at the repository level.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"", "tags": [ "repos" ], "operationId": "repos/get-repo-rule-suites", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#list-repository-rule-suites" }, "parameters": [ { @@ -685945,7 +692739,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -685954,7 +692748,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -686132,14 +692926,14 @@ "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}": { "get": { "summary": "Get a repository rule suite", - "description": "Gets information about a suite of rule evaluations from within a repository.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"", + "description": "Gets information about a suite of rule evaluations from within a repository.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"", "tags": [ "repos" ], "operationId": "repos/get-repo-rule-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#get-a-repository-rule-suite" }, "parameters": [ { @@ -686162,7 +692956,7 @@ }, { "name": "rule_suite_id", - "description": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.", + "description": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.", "in": "path", "required": true, "schema": { @@ -686431,7 +693225,7 @@ "operationId": "repos/get-repo-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-a-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-a-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -686550,7 +693344,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -686560,7 +693354,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -687726,7 +694521,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -687736,7 +694531,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -687922,7 +694717,7 @@ "operationId": "repos/update-repo-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#update-a-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#update-a-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -688005,7 +694800,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -688015,7 +694810,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -688891,7 +695687,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -688901,7 +695697,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -689074,7 +695870,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -689084,7 +695880,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -690250,7 +697047,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -690260,7 +697057,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -690521,7 +697318,7 @@ "operationId": "repos/delete-repo-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#delete-a-repository-ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#delete-a-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -690627,7 +697424,7 @@ "operationId": "repos/get-repo-ruleset-history", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-repository-ruleset-history" }, "parameters": [ { @@ -690650,7 +697447,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -690659,7 +697456,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -690820,7 +697617,7 @@ "operationId": "repos/get-repo-ruleset-version", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-repository-ruleset-version" }, "parameters": [ { @@ -691034,7 +697831,7 @@ "operationId": "secret-scanning/list-alerts-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository" }, "parameters": [ { @@ -691071,7 +697868,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -691080,7 +697877,7 @@ { "name": "exclude_secret_types", "in": "query", - "description": "A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the `secret_type` parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "description": "A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the `secret_type` parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -691166,7 +697963,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -691175,7 +697972,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -691184,7 +697981,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.", "in": "query", "required": false, "schema": { @@ -691193,7 +697990,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.", "in": "query", "required": false, "schema": { @@ -691509,7 +698306,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -692885,7 +699682,7 @@ "operationId": "secret-scanning/get-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert" }, "parameters": [ { @@ -693195,7 +699992,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -694479,7 +701276,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert" }, "parameters": [ { @@ -694554,6 +701351,18 @@ "string", "null" ] + }, + "validity": { + "type": [ + "string", + "null" + ], + "enum": [ + "active", + "inactive", + null + ], + "description": "Sets the validity of the secret scanning alert. Can be `active`, `inactive`, or `null` to clear the override." } }, "anyOf": [ @@ -694864,7 +701673,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -696150,7 +702959,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" + "description": "State does not match the resolution or resolution comment, assignee does not have write access to the repository, or the requested validity change could not be applied to this alert" }, "503": { "description": "Service unavailable", @@ -696192,7 +703001,7 @@ "operationId": "secret-scanning/list-locations-for-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert" }, "parameters": [ { @@ -696226,7 +703035,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -696235,7 +703044,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -696826,7 +703635,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#create-a-push-protection-bypass" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass" }, "parameters": [ { @@ -696970,14 +703779,14 @@ "/repos/{owner}/{repo}/secret-scanning/scan-history": { "get": { "summary": "Get secret scanning scan history for a repository", - "description": "Lists the latest default incremental and backfill scans by type for a repository.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Lists the latest default incremental and backfill scans by type for a repository.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest/get-started/learning-about-github/about-github-advanced-security).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "tags": [ "secret-scanning" ], "operationId": "secret-scanning/get-scan-history", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository" }, "parameters": [ { @@ -697304,7 +704113,7 @@ "operationId": "security-advisories/list-repository-advisories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#list-repository-security-advisories" }, "parameters": [ { @@ -697356,7 +704165,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -697365,7 +704174,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -697374,7 +704183,7 @@ }, { "name": "per_page", - "description": "The number of advisories to return per page. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of advisories to return per page. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -699957,7 +706766,7 @@ "operationId": "security-advisories/create-repository-advisory", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-repository-security-advisory" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#create-a-repository-security-advisory" }, "parameters": [ { @@ -702637,14 +709446,14 @@ "/repos/{owner}/{repo}/security-advisories/reports": { "post": { "summary": "Privately report a security vulnerability", - "description": "Report a security vulnerability to the maintainers of the repository.\nSee \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\" for more information about private vulnerability reporting.", + "description": "Report a security vulnerability to the maintainers of the repository.\nSee \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\" for more information about private vulnerability reporting.", "tags": [ "security-advisories" ], "operationId": "security-advisories/create-private-vulnerability-report", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability" }, "parameters": [ { @@ -705126,7 +711935,7 @@ "operationId": "security-advisories/get-repository-advisory", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#get-a-repository-security-advisory" }, "parameters": [ { @@ -707480,7 +714289,7 @@ "operationId": "security-advisories/update-repository-advisory", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#update-a-repository-security-advisory" }, "parameters": [ { @@ -710427,14 +717236,14 @@ "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve": { "post": { "summary": "Request a CVE for a repository security advisory", - "description": "If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see \"[Requesting a CVE identification number](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional).\"\n\nYou may request a CVE for public repositories, but cannot do so for private repositories.\n\nIn order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.", + "description": "If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see \"[Requesting a CVE identification number](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional).\"\n\nYou may request a CVE for public repositories, but cannot do so for private repositories.\n\nIn order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.", "tags": [ "security-advisories" ], "operationId": "security-advisories/create-repository-advisory-cve-request", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory" }, "parameters": [ { @@ -710695,7 +717504,7 @@ "operationId": "security-advisories/create-fork", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-temporary-private-fork" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#create-a-temporary-private-fork" }, "parameters": [ { @@ -715706,14 +722515,14 @@ "/repos/{owner}/{repo}/stargazers": { "get": { "summary": "List stargazers", - "description": "Lists the people that have starred the repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", + "description": "Lists the people that have starred the repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", "tags": [ "activity" ], "operationId": "activity/list-stargazers-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-stargazers" }, "parameters": [ { @@ -715736,7 +722545,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -715745,7 +722554,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -716286,7 +723095,7 @@ "operationId": "repos/get-code-frequency-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-weekly-commit-activity" }, "parameters": [ { @@ -716378,7 +723187,7 @@ "operationId": "repos/get-commit-activity-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-last-year-of-commit-activity" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-last-year-of-commit-activity" }, "parameters": [ { @@ -716506,7 +723315,7 @@ "operationId": "repos/get-contributors-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-all-contributor-commit-activity" }, "parameters": [ { @@ -716834,7 +723643,7 @@ "operationId": "repos/get-participation-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-weekly-commit-count" }, "parameters": [ { @@ -717045,7 +723854,7 @@ "operationId": "repos/get-punch-card-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-hourly-commit-count-for-each-day" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day" }, "parameters": [ { @@ -717129,7 +723938,7 @@ "operationId": "repos/create-commit-status", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#create-a-commit-status" }, "parameters": [ { @@ -717519,7 +724328,7 @@ "operationId": "activity/list-watchers-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#list-watchers" }, "parameters": [ { @@ -717542,7 +724351,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -717551,7 +724360,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -717791,7 +724600,7 @@ "operationId": "activity/get-repo-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#get-a-repository-subscription" }, "parameters": [ { @@ -717925,14 +724734,14 @@ }, "put": { "summary": "Set a repository subscription", - "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription) completely.", + "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#delete-a-repository-subscription) completely.", "tags": [ "activity" ], "operationId": "activity/set-repo-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#set-a-repository-subscription" }, "parameters": [ { @@ -718065,14 +724874,14 @@ }, "delete": { "summary": "Delete a repository subscription", - "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription).", + "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#set-a-repository-subscription).", "tags": [ "activity" ], "operationId": "activity/delete-repo-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#delete-a-repository-subscription" }, "parameters": [ { @@ -718117,7 +724926,7 @@ "operationId": "repos/list-tags", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-tags" }, "parameters": [ { @@ -718140,7 +724949,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -718149,7 +724958,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -718263,7 +725072,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#download-a-repository-archive-tar" }, "operationId": "repos/download-tarball-archive", "parameters": [ @@ -718326,7 +725135,7 @@ "operationId": "repos/list-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-teams" }, "parameters": [ { @@ -718349,7 +725158,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -718358,7 +725167,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -718707,7 +725516,7 @@ "operationId": "repos/get-all-topics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-all-repository-topics" }, "parameters": [ { @@ -718730,7 +725539,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -718739,7 +725548,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -718826,7 +725635,7 @@ "operationId": "repos/replace-all-topics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#replace-all-repository-topics" }, "parameters": [ { @@ -718993,7 +725802,7 @@ "operationId": "repos/get-clones", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-repository-clones" }, "parameters": [ { @@ -719215,7 +726024,7 @@ "operationId": "repos/get-top-paths", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-top-referral-paths" }, "parameters": [ { @@ -719396,7 +726205,7 @@ "operationId": "repos/get-top-referrers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-top-referral-sources" }, "parameters": [ { @@ -719530,7 +726339,7 @@ "operationId": "repos/get-views", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-page-views" }, "parameters": [ { @@ -719745,14 +726554,14 @@ "/repos/{owner}/{repo}/transfer": { "post": { "summary": "Transfer a repository", - "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-cloud@latest//articles/about-repository-transfers/).", + "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-cloud@latest/articles/about-repository-transfers/).", "tags": [ "repos" ], "operationId": "repos/transfer", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#transfer-a-repository" }, "parameters": [ { @@ -721009,14 +727818,14 @@ "/repos/{owner}/{repo}/vulnerability-alerts": { "get": { "summary": "Check if vulnerability alerts are enabled for a repository", - "description": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)\".", + "description": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest/articles/about-security-alerts-for-vulnerable-dependencies)\".", "tags": [ "repos" ], "operationId": "repos/check-vulnerability-alerts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository" }, "parameters": [ { @@ -721055,14 +727864,14 @@ }, "put": { "summary": "Enable vulnerability alerts", - "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)\".", + "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest/articles/about-security-alerts-for-vulnerable-dependencies)\".", "tags": [ "repos" ], "operationId": "repos/enable-vulnerability-alerts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-vulnerability-alerts" }, "parameters": [ { @@ -721098,14 +727907,14 @@ }, "delete": { "summary": "Disable vulnerability alerts", - "description": "Disables dependency alerts and the dependency graph for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)\".", + "description": "Disables dependency alerts and the dependency graph for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest/articles/about-security-alerts-for-vulnerable-dependencies)\".", "tags": [ "repos" ], "operationId": "repos/disable-vulnerability-alerts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-vulnerability-alerts" }, "parameters": [ { @@ -721149,7 +727958,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#download-a-repository-archive-zip" }, "operationId": "repos/download-zipball-archive", "parameters": [ @@ -721205,14 +728014,14 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.", "tags": [ "repos" ], "operationId": "repos/create-using-template", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-using-a-template" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-using-a-template" }, "parameters": [ { @@ -726075,14 +732884,14 @@ "/repositories": { "get": { "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote:\n- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNote:\n- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.", "tags": [ "repos" ], "operationId": "repos/list-public", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-public-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-public-repositories" }, "parameters": [ { @@ -727230,7 +734039,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise" }, "parameters": [ { @@ -727844,7 +734653,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#provision-a-scim-enterprise-group" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#provision-a-scim-enterprise-group" }, "parameters": [ { @@ -728438,7 +735247,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group" }, "parameters": [ { @@ -728985,7 +735794,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group" }, "parameters": [ { @@ -729654,7 +736463,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group" }, "parameters": [ { @@ -730314,7 +737123,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise" }, "parameters": [ { @@ -730661,7 +737470,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise" }, "parameters": [ { @@ -731353,7 +738162,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#provision-a-scim-enterprise-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#provision-a-scim-enterprise-user" }, "parameters": [ { @@ -732229,7 +739038,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user" }, "parameters": [ { @@ -732857,7 +739666,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user" }, "parameters": [ { @@ -733698,7 +740507,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user" }, "parameters": [ { @@ -734512,7 +741321,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise" }, "parameters": [ { @@ -734856,7 +741665,7 @@ "operationId": "scim/list-provisioned-identities", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#list-scim-provisioned-identities" }, "parameters": [ { @@ -735672,14 +742481,14 @@ }, "post": { "summary": "Provision and invite a SCIM user", - "description": "Provisions organization membership for a user, and sends an activation email to the email address. If the user was previously a member of the organization, the invitation will reinstate any former privileges that the user had. For more information about reinstating former members, see \"[Reinstating a former member of your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization).\"", + "description": "Provisions organization membership for a user, and sends an activation email to the email address. If the user was previously a member of the organization, the invitation will reinstate any former privileges that the user had. For more information about reinstating former members, see \"[Reinstating a former member of your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization).\"", "tags": [ "scim" ], "operationId": "scim/provision-and-invite-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#provision-and-invite-a-scim-user" }, "parameters": [ { @@ -736570,7 +743379,7 @@ "operationId": "scim/get-provisioning-information-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#get-scim-provisioning-information-for-a-user" }, "parameters": [ { @@ -737069,14 +743878,14 @@ }, "put": { "summary": "Update a provisioned organization membership", - "description": "Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user) endpoint instead.\n\nYou must at least provide the required values for the user: `userName`, `name`, and `emails`.\n\n> [!WARNING]\n> Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`.", + "description": "Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-an-attribute-for-a-scim-user) endpoint instead.\n\nYou must at least provide the required values for the user: `userName`, `name`, and `emails`.\n\n> [!WARNING]\n> Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`.", "tags": [ "scim" ], "operationId": "scim/set-information-for-provisioned-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-a-provisioned-organization-membership" }, "parameters": [ { @@ -737704,7 +744513,7 @@ "operationId": "scim/update-attribute-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-an-attribute-for-a-scim-user" }, "parameters": [ { @@ -738448,7 +745257,7 @@ "operationId": "scim/delete-user-from-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#delete-a-scim-user-from-an-organization" }, "parameters": [ { @@ -738667,19 +745476,19 @@ "/search/code": { "get": { "summary": "Search code", - "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\n> [!NOTE]\n> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", + "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\n> [!NOTE]\n> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", "tags": [ "search" ], "operationId": "search/code", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-code" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See \"[Searching code](https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-code)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). See \"[Searching code](https://docs.github.com/enterprise-cloud@latest/search-github/searching-on-github/searching-code)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -738689,7 +745498,7 @@ { "name": "sort", "deprecated": true, - "description": "**This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Cloud search infrastructure. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", + "description": "**This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Cloud search infrastructure. Default: [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -738716,7 +745525,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -738725,7 +745534,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -740031,19 +746840,19 @@ "/search/commits": { "get": { "summary": "Search commits", - "description": "Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`", + "description": "Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`", "tags": [ "search" ], "operationId": "search/commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-commits" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-commits" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See \"[Searching commits](https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-commits)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). See \"[Searching commits](https://docs.github.com/enterprise-cloud@latest/search-github/searching-on-github/searching-commits)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -740052,7 +746861,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -740079,7 +746888,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -740088,7 +746897,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -741649,19 +748458,19 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n> [!NOTE]\n> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n> [!NOTE]\n> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", "tags": [ "search" ], "operationId": "search/issues-and-pull-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-issues-and-pull-requests" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-issues-and-pull-requests" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-issues-and-pull-requests)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://docs.github.com/enterprise-cloud@latest/search-github/searching-on-github/searching-issues-and-pull-requests)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -741670,7 +748479,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -741706,7 +748515,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -741715,7 +748524,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -745760,14 +752569,14 @@ "/search/labels": { "get": { "summary": "Search labels", - "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", + "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", "tags": [ "search" ], "operationId": "search/labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-labels" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-labels" }, "parameters": [ { @@ -745781,7 +752590,7 @@ }, { "name": "q", - "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query).", + "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query).", "in": "query", "required": true, "schema": { @@ -745790,7 +752599,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -745817,7 +752626,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -745826,7 +752635,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -746119,19 +752928,19 @@ "/search/repositories": { "get": { "summary": "Search repositories", - "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", + "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", "tags": [ "search" ], "operationId": "search/repos", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-repositories" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-cloud@latest//articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-cloud@latest/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -746140,7 +752949,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -746169,7 +752978,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -746178,7 +752987,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -747131,19 +753940,19 @@ "/search/topics": { "get": { "summary": "Search topics", - "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/enterprise-cloud@latest//articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", + "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/enterprise-cloud@latest/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", "tags": [ "search" ], "operationId": "search/topics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-topics" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-topics" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query).", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query).", "in": "query", "required": true, "schema": { @@ -747152,7 +753961,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -747161,7 +753970,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -747479,19 +754288,19 @@ "/search/users": { "get": { "summary": "Search users", - "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.\n\nThis endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"[GraphQL Queries](https://docs.github.com/enterprise-cloud@latest//graphql/reference/queries#search).\"", + "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.\n\nThis endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"[GraphQL Queries](https://docs.github.com/enterprise-cloud@latest/graphql/reference/queries#search).\"", "tags": [ "search" ], "operationId": "search/users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-users" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-users" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/enterprise-cloud@latest/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -747500,7 +754309,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Cloud. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Cloud. Default: [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -747528,7 +754337,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -747537,7 +754346,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -747925,14 +754734,14 @@ "/teams/{team_id}": { "get": { "summary": "Get a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#get-a-team-by-name) endpoint.", "tags": [ "teams" ], "operationId": "teams/get-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#get-a-team-legacy" }, "parameters": [ { @@ -748737,14 +755546,14 @@ }, "patch": { "summary": "Update a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> With nested teams, the `privacy` for parent teams cannot be `secret`.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> With nested teams, the `privacy` for parent teams cannot be `secret`.", "tags": [ "teams" ], "operationId": "teams/update-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#update-a-team-legacy" }, "parameters": [ { @@ -750468,14 +757277,14 @@ }, "delete": { "summary": "Delete a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", "tags": [ "teams" ], "operationId": "teams/delete-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#delete-a-team-legacy" }, "parameters": [ { @@ -750608,14 +757417,14 @@ "/teams/{team_id}/invitations": { "get": { "summary": "List pending team invitations (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations) endpoint.\n\nThe return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-pending-team-invitations) endpoint.\n\nThe return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`.", "tags": [ "teams" ], "operationId": "teams/list-pending-invitations-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-pending-team-invitations-legacy" }, "parameters": [ { @@ -750629,7 +757438,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -750638,7 +757447,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -750960,14 +757769,14 @@ "/teams/{team_id}/members": { "get": { "summary": "List team members (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", "tags": [ "teams" ], "operationId": "teams/list-members-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-team-members-legacy" }, "parameters": [ { @@ -750996,7 +757805,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -751005,7 +757814,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -751267,14 +758076,14 @@ "/teams/{team_id}/members/{username}": { "get": { "summary": "Get team member (Legacy)", - "description": "The \"Get team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "description": "The \"Get team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", "tags": [ "teams" ], "operationId": "teams/get-member-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-member-legacy" }, "parameters": [ { @@ -751316,14 +758125,14 @@ }, "put": { "summary": "Add team member (Legacy)", - "description": "The \"Add team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "The \"Add team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "teams" ], "operationId": "teams/add-member-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-team-member-legacy" }, "parameters": [ { @@ -751394,14 +758203,14 @@ }, "delete": { "summary": "Remove team member (Legacy)", - "description": "The \"Remove team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "The \"Remove team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "tags": [ "teams" ], "operationId": "teams/remove-member-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-member-legacy" }, "parameters": [ { @@ -751445,14 +758254,14 @@ "/teams/{team_id}/memberships/{username}": { "get": { "summary": "Get team membership for a user (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team).", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#create-a-team).", "tags": [ "teams" ], "operationId": "teams/get-membership-for-user-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-membership-for-a-user-legacy" }, "parameters": [ { @@ -751567,14 +758376,14 @@ }, "put": { "summary": "Add or update team membership for a user (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", "tags": [ "teams" ], "operationId": "teams/add-or-update-membership-for-user-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-or-update-team-membership-for-a-user-legacy" }, "parameters": [ { @@ -751724,14 +758533,14 @@ }, "delete": { "summary": "Remove team membership for a user (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "tags": [ "teams" ], "operationId": "teams/remove-membership-for-user-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-membership-for-a-user-legacy" }, "parameters": [ { @@ -751775,14 +758584,14 @@ "/teams/{team_id}/repos": { "get": { "summary": "List team repositories (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-team-repositories) endpoint.", "tags": [ "teams" ], "operationId": "teams/list-repos-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-team-repositories-legacy" }, "parameters": [ { @@ -751796,7 +758605,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -751805,7 +758614,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -752943,14 +759752,14 @@ "/teams/{team_id}/repos/{owner}/{repo}": { "get": { "summary": "Check team permissions for a repository (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository) endpoint.\n\n> [!NOTE]\n> Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header:", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.\n\n> [!NOTE]\n> Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header:", "tags": [ "teams" ], "operationId": "teams/check-permissions-for-repo-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#check-team-permissions-for-a-repository-legacy" }, "parameters": [ { @@ -754031,14 +760840,14 @@ }, "put": { "summary": "Add or update team repository permissions (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "teams" ], "operationId": "teams/add-or-update-repo-permissions-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#add-or-update-team-repository-permissions-legacy" }, "parameters": [ { @@ -754216,14 +761025,14 @@ }, "delete": { "summary": "Remove a repository from a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", "tags": [ "teams" ], "operationId": "teams/remove-repo-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#remove-a-repository-from-a-team-legacy" }, "parameters": [ { @@ -754273,14 +761082,14 @@ "/teams/{team_id}/team-sync/group-mappings": { "get": { "summary": "List IdP groups for a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nList IdP groups connected to a team on GitHub Enterprise Cloud.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#list-idp-groups-for-a-team) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nList IdP groups connected to a team on GitHub Enterprise Cloud.", "tags": [ "teams" ], "operationId": "teams/list-idp-groups-for-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#list-idp-groups-for-a-team-legacy" }, "parameters": [ { @@ -754455,14 +761264,14 @@ }, "patch": { "summary": "Create or update IdP group connections (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nCreates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#create-or-update-idp-group-connections) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nCreates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team.", "tags": [ "teams" ], "operationId": "teams/create-or-update-idp-group-connections-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#create-or-update-idp-group-connections-legacy" }, "parameters": [ { @@ -754762,14 +761571,14 @@ "/teams/{team_id}/teams": { "get": { "summary": "List child teams (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-child-teams) endpoint.", "tags": [ "teams" ], "operationId": "teams/list-child-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-child-teams-legacy" }, "parameters": [ { @@ -754783,7 +761592,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -754792,7 +761601,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -755258,7 +762067,7 @@ "operationId": "users/get-authenticated", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/users#get-the-authenticated-user" }, "parameters": [], "responses": { @@ -756021,7 +762830,7 @@ "operationId": "users/update-authenticated", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/users#update-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/users#update-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -756680,12 +763489,12 @@ "operationId": "users/list-blocked-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#list-users-blocked-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/blocking#list-users-blocked-by-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -756694,7 +763503,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -757007,7 +763816,7 @@ "operationId": "users/check-blocked", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user" }, "parameters": [ { @@ -757122,7 +763931,7 @@ "operationId": "users/block", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/blocking#block-a-user" }, "parameters": [ { @@ -757312,7 +764121,7 @@ "operationId": "users/unblock", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/blocking#unblock-a-user" }, "parameters": [ { @@ -757429,12 +764238,12 @@ "operationId": "codespaces/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#list-codespaces-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#list-codespaces-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -757443,7 +764252,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -759709,7 +766518,7 @@ "operationId": "codespaces/create-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-for-the-authenticated-user" }, "requestBody": { "required": true, @@ -763614,12 +770423,12 @@ "operationId": "codespaces/list-secrets-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-secrets-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#list-secrets-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -763628,7 +770437,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -763755,7 +770564,7 @@ "operationId": "codespaces/get-public-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-public-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#get-public-key-for-the-authenticated-user" }, "responses": { "200": { @@ -763817,7 +770626,7 @@ "operationId": "codespaces/get-secret-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-a-secret-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user" }, "parameters": [ { @@ -763907,14 +770716,14 @@ }, "put": { "summary": "Create or update a secret for the authenticated user", - "description": "Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", + "description": "Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", "tags": [ "codespaces" ], "operationId": "codespaces/create-or-update-secret-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user" }, "parameters": [ { @@ -763936,7 +770745,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -763945,7 +770754,7 @@ }, "selected_repository_ids": { "type": "array", - "description": "An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints.", + "description": "An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints.", "items": { "anyOf": [ { @@ -764118,7 +770927,7 @@ "operationId": "codespaces/delete-secret-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user" }, "parameters": [ { @@ -764154,7 +770963,7 @@ "operationId": "codespaces/list-repositories-for-secret-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret" }, "parameters": [ { @@ -765504,7 +772313,7 @@ "operationId": "codespaces/set-repositories-for-secret-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#set-selected-repositories-for-a-user-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret" }, "parameters": [ { @@ -765526,7 +772335,7 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints.", + "description": "An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints.", "items": { "type": "integer" } @@ -765676,7 +772485,7 @@ "operationId": "codespaces/add-repository-for-secret-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret" }, "parameters": [ { @@ -765822,7 +772631,7 @@ "operationId": "codespaces/remove-repository-for-secret-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret" }, "parameters": [ { @@ -765970,7 +772779,7 @@ "operationId": "codespaces/get-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user" }, "parameters": [ { @@ -767931,7 +774740,7 @@ "operationId": "codespaces/update-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user" }, "parameters": [ { @@ -769897,7 +776706,7 @@ "operationId": "codespaces/delete-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user" }, "parameters": [ { @@ -770052,7 +776861,7 @@ "operationId": "codespaces/export-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user" }, "parameters": [ { @@ -770355,7 +777164,7 @@ "operationId": "codespaces/get-export-details-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#get-details-about-a-codespace-export" }, "parameters": [ { @@ -770514,7 +777323,7 @@ "operationId": "codespaces/codespace-machines-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/machines#list-machine-types-for-a-codespace" }, "parameters": [ { @@ -770775,7 +777584,7 @@ "operationId": "codespaces/publish-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace" }, "parameters": [ { @@ -776550,7 +783359,7 @@ "operationId": "codespaces/start-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user" }, "parameters": [ { @@ -778633,7 +785442,7 @@ "operationId": "codespaces/stop-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user" }, "parameters": [ { @@ -780593,7 +787402,7 @@ "operationId": "packages/list-docker-migration-conflicting-packages-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user" }, "responses": { "200": { @@ -781901,7 +788710,7 @@ "operationId": "users/set-primary-email-visibility-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/emails#set-primary-email-visibility-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -782174,12 +788983,12 @@ "operationId": "users/list-emails-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/emails#list-email-addresses-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/emails#list-email-addresses-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -782188,7 +788997,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -782366,7 +789175,7 @@ "operationId": "users/add-email-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/emails#add-an-email-address-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/emails#add-an-email-address-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -782680,7 +789489,7 @@ "operationId": "users/delete-email-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/emails#delete-an-email-address-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/emails#delete-an-email-address-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -782922,12 +789731,12 @@ "operationId": "users/list-followers-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/followers#list-followers-of-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -782936,7 +789745,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -783231,12 +790040,12 @@ "operationId": "users/list-followed-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-the-authenticated-user-follows" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/followers#list-the-people-the-authenticated-user-follows" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -783245,7 +790054,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -783540,7 +790349,7 @@ "operationId": "users/check-person-is-followed-by-authenticated", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user" }, "parameters": [ { @@ -783648,14 +790457,14 @@ }, "put": { "summary": "Follow a user", - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.", "tags": [ "users" ], "operationId": "users/follow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/followers#follow-a-user" }, "parameters": [ { @@ -783845,7 +790654,7 @@ "operationId": "users/unfollow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/followers#unfollow-a-user" }, "parameters": [ { @@ -783962,12 +790771,12 @@ "operationId": "users/list-gpg-keys-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -783976,7 +790785,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -784350,7 +791159,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -784814,7 +791623,7 @@ "operationId": "users/get-gpg-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user" }, "parameters": [ { @@ -785180,7 +791989,7 @@ "operationId": "users/delete-gpg-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user" }, "parameters": [ { @@ -785372,12 +792181,12 @@ "operationId": "apps/list-installations-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#list-app-installations-accessible-to-the-user-access-token" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -785386,7 +792195,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -786019,7 +792828,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -786654,7 +793463,7 @@ "operationId": "apps/list-installation-repos-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#list-repositories-accessible-to-the-user-access-token" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#list-repositories-accessible-to-the-user-access-token" }, "parameters": [ { @@ -786673,7 +793482,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -786682,7 +793491,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -787902,7 +794711,7 @@ "operationId": "apps/add-repo-to-installation-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#add-a-repository-to-an-app-installation" }, "parameters": [ { @@ -788005,7 +794814,7 @@ "operationId": "apps/remove-repo-from-installation-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#remove-a-repository-from-an-app-installation" }, "parameters": [ { @@ -788113,7 +794922,7 @@ "operationId": "interactions/get-restrictions-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/interactions/user#get-interaction-restrictions-for-your-public-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/interactions/user#get-interaction-restrictions-for-your-public-repositories" }, "responses": { "200": { @@ -788198,7 +795007,7 @@ "operationId": "interactions/set-restrictions-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/interactions/user#set-interaction-restrictions-for-your-public-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/interactions/user#set-interaction-restrictions-for-your-public-repositories" }, "requestBody": { "required": true, @@ -788397,7 +795206,7 @@ "operationId": "interactions/remove-restrictions-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/interactions/user#remove-interaction-restrictions-from-your-public-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/interactions/user#remove-interaction-restrictions-from-your-public-repositories" }, "responses": { "204": { @@ -788415,14 +795224,14 @@ "/user/issues": { "get": { "summary": "List user account issues assigned to the authenticated user", - "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user" }, "parameters": [ { @@ -788508,7 +795317,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -788517,7 +795326,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -792719,12 +799528,12 @@ "operationId": "users/list-public-ssh-keys-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-ssh-keys-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -792733,7 +799542,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -792928,7 +799737,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -793208,7 +800017,7 @@ "operationId": "users/get-public-ssh-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user" }, "parameters": [ { @@ -793386,7 +800195,7 @@ "operationId": "users/delete-public-ssh-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user" }, "parameters": [ { @@ -793503,12 +800312,12 @@ "operationId": "apps/list-subscriptions-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-subscriptions-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -793517,7 +800326,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -793877,12 +800686,12 @@ "operationId": "apps/list-subscriptions-for-authenticated-user-stubbed", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -793891,7 +800700,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -794225,7 +801034,7 @@ "operationId": "orgs/list-memberships-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-memberships-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-organization-memberships-for-the-authenticated-user" }, "parameters": [ { @@ -794243,7 +801052,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -794252,7 +801061,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -794877,7 +801686,7 @@ "operationId": "orgs/get-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-an-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user" }, "parameters": [ { @@ -795372,7 +802181,7 @@ "operationId": "orgs/update-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#update-an-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user" }, "parameters": [ { @@ -795973,12 +802782,12 @@ "operationId": "migrations/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-user-migrations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#list-user-migrations" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -795987,7 +802796,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -797501,7 +804310,7 @@ "operationId": "migrations/start-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#start-a-user-migration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#start-a-user-migration" }, "parameters": [], "requestBody": { @@ -799176,14 +805985,14 @@ "/user/migrations/{migration_id}": { "get": { "summary": "Get a user migration status", - "description": "Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values:\n\n* `pending` - the migration hasn't started yet.\n* `exporting` - the migration is in progress.\n* `exported` - the migration finished successfully.\n* `failed` - the migration failed.\n\nOnce the migration has been `exported` you can [download the migration archive](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive).", + "description": "Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values:\n\n* `pending` - the migration hasn't started yet.\n* `exporting` - the migration is in progress.\n* `exported` - the migration finished successfully.\n* `failed` - the migration failed.\n\nOnce the migration has been `exported` you can [download the migration archive](https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#download-a-user-migration-archive).", "tags": [ "migrations" ], "operationId": "migrations/get-status-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#get-a-user-migration-status" }, "parameters": [ { @@ -800729,7 +807538,7 @@ "operationId": "migrations/get-archive-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#download-a-user-migration-archive" }, "parameters": [ { @@ -800811,14 +807620,14 @@ }, "delete": { "summary": "Delete a user migration archive", - "description": "Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted.", + "description": "Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted.", "tags": [ "migrations" ], "operationId": "migrations/delete-archive-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#delete-a-user-migration-archive" }, "parameters": [ { @@ -800928,14 +807737,14 @@ "/user/migrations/{migration_id}/repos/{repo_name}/lock": { "delete": { "summary": "Unlock a user repository", - "description": "Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked.", + "description": "Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked.", "tags": [ "migrations" ], "operationId": "migrations/unlock-repo-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#unlock-a-user-repository" }, "parameters": [ { @@ -801061,7 +807870,7 @@ "operationId": "migrations/list-repos-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#list-repositories-for-a-user-migration" }, "parameters": [ { @@ -801075,7 +807884,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -801084,7 +807893,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -802226,12 +809035,12 @@ "operationId": "orgs/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-organizations-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -802240,7 +809049,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -802453,14 +809262,14 @@ "/user/packages": { "get": { "summary": "List packages for the authenticated user's namespace", - "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/list-packages-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-packages-for-the-authenticated-users-namespace" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-packages-for-the-authenticated-users-namespace" }, "parameters": [ { @@ -802482,7 +809291,7 @@ }, { "name": "visibility", - "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", + "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", "in": "query", "required": false, "schema": { @@ -802496,7 +809305,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -802505,7 +809314,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -803815,14 +810624,14 @@ "/user/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for the authenticated user", - "description": "Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-for-the-authenticated-user" }, "parameters": [ { @@ -805180,14 +811989,14 @@ }, "delete": { "summary": "Delete a package for the authenticated user", - "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-a-package-for-the-authenticated-user" }, "parameters": [ { @@ -805311,14 +812120,14 @@ "/user/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for the authenticated user", - "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-a-package-for-the-authenticated-user" }, "parameters": [ { @@ -805451,14 +812260,14 @@ "/user/packages/{package_type}/{package_name}/versions": { "get": { "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\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user" }, "parameters": [ { @@ -805489,7 +812298,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -805498,7 +812307,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -805789,14 +812598,14 @@ "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for the authenticated user", - "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-version-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-version-for-the-authenticated-user" }, "parameters": [ { @@ -806004,14 +812813,14 @@ }, "delete": { "summary": "Delete a package version for the authenticated user", - "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-version-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-version-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-a-package-version-for-the-authenticated-user" }, "parameters": [ { @@ -806144,14 +812953,14 @@ "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore a package version for the authenticated user", - "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-version-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-version-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-a-package-version-for-the-authenticated-user" }, "parameters": [ { @@ -806284,19 +813093,19 @@ "/user/public_emails": { "get": { "summary": "List public email addresses for the authenticated user", - "description": "Lists your publicly visible email address, which you can set with the\n[Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)\nendpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.", + "description": "Lists your publicly visible email address, which you can set with the\n[Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-cloud@latest/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)\nendpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.", "tags": [ "users" ], "operationId": "users/list-public-emails-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/emails#list-public-email-addresses-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/emails#list-public-email-addresses-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -806305,7 +813114,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -806485,7 +813294,7 @@ "operationId": "repos/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repositories-for-the-authenticated-user" }, "parameters": [ { @@ -806561,7 +813370,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -806570,7 +813379,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -807862,7 +814671,7 @@ "operationId": "repos/create-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -813080,12 +819889,12 @@ "operationId": "repos/list-invitations-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -813094,7 +819903,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -814704,7 +821513,7 @@ "operationId": "repos/accept-invitation-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#accept-a-repository-invitation" }, "parameters": [ { @@ -814819,7 +821628,7 @@ "operationId": "repos/decline-invitation-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#decline-a-repository-invitation" }, "parameters": [ { @@ -814936,12 +821745,12 @@ "operationId": "users/list-social-accounts-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#list-social-accounts-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -814950,7 +821759,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -815108,7 +821917,7 @@ "operationId": "users/add-social-account-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#add-social-accounts-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -815371,7 +822180,7 @@ "operationId": "users/delete-social-account-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -815596,12 +822405,12 @@ "operationId": "users/list-ssh-signing-keys-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -815610,7 +822419,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -815780,7 +822589,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -815797,7 +822606,7 @@ ] }, "key": { - "description": "The public SSH key to add to your GitHub account. For more information, see \"[Checking for existing SSH keys](https://docs.github.com/enterprise-cloud@latest//authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).\"", + "description": "The public SSH key to add to your GitHub account. For more information, see \"[Checking for existing SSH keys](https://docs.github.com/enterprise-cloud@latest/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).\"", "type": "string", "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com " } @@ -816037,7 +822846,7 @@ "operationId": "users/get-ssh-signing-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user" }, "parameters": [ { @@ -816192,7 +823001,7 @@ "operationId": "users/delete-ssh-signing-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user" }, "parameters": [ { @@ -816302,14 +823111,14 @@ "/user/starred": { "get": { "summary": "List repositories starred by the authenticated user", - "description": "Lists repositories the authenticated user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", + "description": "Lists repositories the authenticated user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", "tags": [ "activity" ], "operationId": "activity/list-repos-starred-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-repositories-starred-by-the-authenticated-user" }, "parameters": [ { @@ -816342,7 +823151,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -816351,7 +823160,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -818671,7 +825480,7 @@ "operationId": "activity/check-repo-is-starred-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user" }, "parameters": [ { @@ -818788,14 +825597,14 @@ }, "put": { "summary": "Star a repository for the authenticated user", - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "activity" ], "operationId": "activity/star-repo-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#star-a-repository-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#star-a-repository-for-the-authenticated-user" }, "parameters": [ { @@ -818919,7 +825728,7 @@ "operationId": "activity/unstar-repo-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#unstar-a-repository-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#unstar-a-repository-for-the-authenticated-user" }, "parameters": [ { @@ -819045,12 +825854,12 @@ "operationId": "activity/list-watched-repos-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#list-repositories-watched-by-the-authenticated-user" }, "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -819059,7 +825868,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -819897,2110 +826706,6591 @@ } } }, - "secret_scanning_delegated_alert_dismissal": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" + "secret_scanning_delegated_alert_dismissal": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + }, + "mode": { + "type": "string", + "description": "The bypass mode for the reviewer", + "enum": [ + "ALWAYS", + "EXEMPT" + ], + "default": "ALWAYS" + } + } + } + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_validity_checks": { + "status": "disabled" + }, + "secret_scanning_delegated_alert_dismissal": { + "status": "disabled" + } + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "watching" + } + } + }, + "/user/teams": { + "get": { + "summary": "List teams for the authenticated user", + "description": "List all of the teams across all of the organizations to which the authenticated\nuser belongs.\n\nOAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint.\n\nWhen using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.", + "tags": [ + "teams" + ], + "operationId": "teams/list-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-teams-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Developers" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "push" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ] + } + ] + }, + "members_count": { + "type": "integer", + "examples": [ + 3 + ] + }, + "repos_count": { + "type": "integer", + "examples": [ + 10 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-14T16:53:42Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-08-17T12:37:15Z" + ] + }, + "organization": { + "title": "Team Organization", + "description": "Team Organization", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "examples": [ + "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type", + "created_at", + "updated_at", + "members_count", + "repos_count", + "organization" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "teams", + "subcategory": "teams" + } + } + }, + "/user/{account_id}": { + "get": { + "summary": "Get a user using their ID", + "description": "Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/enterprise-cloud@latest/rest/users/emails).", + "tags": [ + "users" + ], + "operationId": "users/get-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/users#get-a-user-using-their-id" + }, + "parameters": [ + { + "name": "account_id", + "description": "account_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "user_view_type": { + "type": "string" + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "user_view_type": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + } + ] + }, + "examples": { + "default-response": { + "summary": "Default response", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "response-with-git-hub-plan-information": { + "summary": "Response with GitHub plan information", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "plan": { + "name": "pro", + "space": 976562499, + "collaborators": 0, + "private_repos": 9999 + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" + } + } + }, + "/user/{user_id}/projectsV2/{project_number}/drafts": { + "post": { + "summary": "Create draft item for user owned project", + "description": "Create draft issue item for the specified user owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/create-draft-item-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/drafts#create-draft-item-for-user-owned-project" + }, + "parameters": [ + { + "name": "user_id", + "description": "The unique identifier of the user.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_number", + "description": "The project's number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "description": "Details of the draft item to create in the project.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the draft issue item to create in the project." + }, + "body": { + "type": "string", + "description": "The body content of the draft issue item to create in the project." + } + }, + "required": [ + "title" + ] + }, + "examples": { + "title": { + "summary": "Example with Sample Draft Issue Title", + "value": { + "title": "Sample Draft Issue Title" + } + }, + "body": { + "summary": "Example with Sample Draft Issue Title and Body", + "value": { + "title": "Sample Draft Issue Title", + "body": "This is the body content of the draft issue." + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project item." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project item." + }, + "content": { + "oneOf": [ + { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } ] - } - } - }, - "secret_scanning_delegated_bypass": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } - } - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, "required": [ - "reviewer_id", - "reviewer_type" + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ], + "examples": [ + "all" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] + "lexical_search_ok": { + "type": "boolean" }, - "mode": { - "type": "string", - "description": "The bypass mode for the reviewer", - "enum": [ - "ALWAYS", - "EXEMPT" - ], - "default": "ALWAYS" + "lexical_commit_sha": { + "type": "string" } } } - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_validity_checks": { - "status": "disabled" - }, - "secret_scanning_delegated_alert_dismissal": { - "status": "disabled" - } - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "activity", - "subcategory": "watching" - } - } - }, - "/user/teams": { - "get": { - "summary": "List teams for the authenticated user", - "description": "List all of the teams across all of the organizations to which the authenticated\nuser belongs.\n\nOAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint.\n\nWhen using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.", - "tags": [ - "teams" - ], - "operationId": "teams/list-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams-for-the-authenticated-user" - }, - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "examples": [ - "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "teams", - "subcategory": "teams" - } - } - }, - "/user/{account_id}": { - "get": { - "summary": "Get a user using their ID", - "description": "Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest//enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/enterprise-cloud@latest//rest/users/emails).", - "tags": [ - "users" - ], - "operationId": "users/get-by-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id" - }, - "parameters": [ - { - "name": "account_id", - "description": "account_id parameter", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "title": "Private User", - "description": "Private User", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ], - "examples": [ - "monalisa octocat" - ] - }, - "company": { - "type": [ - "string", - "null" - ], - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": [ - "string", - "null" - ], - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ], - "examples": [ - "There once was..." - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "monalisa" - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "private_gists": { - "type": "integer", - "examples": [ - 81 - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "disk_usage": { - "type": "integer", - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": "integer", - "examples": [ - 8 - ] - }, - "two_factor_authentication": { - "type": "boolean", - "examples": [ - true - ] - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] }, - "name": { - "type": "string" + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] }, - "space": { - "type": "integer" + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "business_plus": { - "type": "boolean" - }, - "ldap_dn": { - "type": "string" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at", - "collaborators", - "disk_usage", - "owned_private_repos", - "private_gists", - "total_private_repos", - "two_factor_authentication" - ] - }, - { - "title": "Public User", - "description": "Public User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] }, - "name": { - "type": "string" + "parent_issue_url": { + "description": "URL to get the parent issue of this issue, if it is a sub-issue", + "type": [ + "string", + "null" + ], + "format": "uri" }, - "space": { - "type": "integer" + "pinned_comment": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/comments/1" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string", + "examples": [ + "What version of Safari were you using when you observed this bug?" + ] + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "pinned_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "pinned_at", + "pinned_by" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ] + } + ] }, - "private_repos": { - "type": "integer" + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "examples": [ + "Sample text" + ] + }, + { + "type": "number", + "examples": [ + 42.5 + ] + }, + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the option", + "type": "string", + "examples": [ + "High" + ] + }, + "color": { + "description": "The color of the option", + "type": "string", + "examples": [ + "red" + ] + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } } }, "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "private_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "disk_usage": { - "type": "integer", - "examples": [ - 1 - ] - }, - "collaborators": { - "type": "integer", - "examples": [ - 3 - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false - } - ] - }, - "examples": { - "default-response": { - "summary": "Default response", - "value": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z" - } - }, - "response-with-git-hub-plan-information": { - "summary": "Response with GitHub plan information", - "value": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z", - "plan": { - "name": "pro", - "space": 976562499, - "collaborators": 0, - "private_repos": 9999 - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "users" - } - } - }, - "/user/{user_id}/projectsV2/{project_number}/drafts": { - "post": { - "summary": "Create draft item for user owned project", - "description": "Create draft issue item for the specified user owned project.", - "tags": [ - "projects" - ], - "operationId": "projects/create-draft-item-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/drafts#create-draft-item-for-user-owned-project" - }, - "parameters": [ - { - "name": "user_id", - "description": "The unique identifier of the user.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_number", - "description": "The project's number.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "description": "Details of the draft item to create in the project.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "The title of the draft issue item to create in the project." - }, - "body": { - "type": "string", - "description": "The body content of the draft issue item to create in the project." - } - }, - "required": [ - "title" - ] - }, - "examples": { - "title": { - "summary": "Example with Sample Draft Issue Title", - "value": { - "title": "Sample Draft Issue Title" - } - }, - "body": { - "summary": "Example with Sample Draft Issue Title and Body", - "value": { - "title": "Sample Draft Issue Title", - "body": "This is the body content of the draft issue." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Projects v2 Item", - "description": "An item belonging to a project", - "type": "object", - "properties": { - "id": { - "type": "number", - "description": "The unique identifier of the project item." - }, - "node_id": { - "type": "string", - "description": "The node ID of the project item." - }, - "content": { - "oneOf": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "created_at", + "updated_at" + ] + }, { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "title": "Pull Request Simple", + "description": "Pull Request Simple", "type": "object", "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/1347" + ] + }, "id": { "type": "integer", - "format": "int64" + "format": "int64", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" + "type": "string", + "examples": [ + "MDExOlB1bGxSZXF1ZXN0MQ==" + ] }, - "url": { - "description": "URL for the issue", + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repositories/42/issues/1" + "https://github.com/octocat/Hello-World/pull/1347" ] }, - "repository_url": { + "diff_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/pull/1347.diff" + ] }, - "labels_url": { - "type": "string" + "patch_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/pull/1347.patch" + ] }, - "comments_url": { + "issue_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] }, - "events_url": { + "commits_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" + ] }, - "html_url": { + "review_comments_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" + ] + }, + "review_comment_url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] }, "number": { - "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ - 42 + 1347 ] }, "state": { - "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, - "state_reason": { - "description": "The reason for the current state", + "locked": { + "type": "boolean", + "examples": [ + true + ] + }, + "title": { + "type": "string", + "examples": [ + "new-feature" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body": { "type": [ "string", "null" ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null + "examples": [ + "Please pull these awesome changes" + ] + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "active_lock_reason": { + "type": [ + "string", + "null" ], "examples": [ - "not_planned" + "too heated" ] }, - "title": { - "description": "Title of the issue", + "created_at": { "type": "string", + "format": "date-time", "examples": [ - "Widget creation fails in Safari on OS X 10.8" + "2011-01-26T19:01:12Z" ] }, - "body": { - "description": "Contents of the issue", + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "closed_at": { "type": [ "string", "null" ], + "format": "date-time", "examples": [ - "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" + "2011-01-26T19:01:12Z" ] }, - "user": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "merge_commit_sha": { + "type": [ + "string", + "null" + ], + "examples": [ + "e5bd3914e2e596debea16f433f57875b5b90bcd6" + ] + }, + "assignee": { "anyOf": [ { "type": "null" @@ -822016,963 +833306,3240 @@ "null" ] }, - "email": { + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "requested_reviewers": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent", + "type" + ] + } + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { "type": [ "string", "null" ] }, - "login": { + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", "type": "string", "examples": [ - "octocat" + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ], + "examples": [ + "all" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" ] }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + }, + "required": [ + "label", + "ref", + "repo", + "sha", + "user" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { "id": { + "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "examples": [ - 1 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "avatar_url": { + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "https://github.com/octocat/Hello-World" ] }, - "gravatar_id": { + "description": { "type": [ "string", "null" ], "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "This your first repo!" ] }, + "fork": { + "type": "boolean" + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "html_url": { + "archive_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "followers_url": { + "assignees_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "following_url": { + "blobs_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "gists_url": { + "branches_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, - "starred_url": { + "collaborators_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, - "subscriptions_url": { + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "organizations_url": { + "deployments_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "repos_url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "received_events_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "type": { + "git_commits_url": { "type": "string", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "git_refs_url": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "user_view_type": { + "git_tags_url": { "type": "string", "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - }, - "examples": [ - "bug", - "registration" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "email": { - "type": [ - "string", - "null" + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" ] }, - "login": { + "issue_comment_url": { "type": "string", "examples": [ - "octocat" + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, - "id": { - "type": "integer", - "format": "int64", + "issue_events_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, - "node_id": { + "issues_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, - "avatar_url": { + "keys_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "labels_url": { + "type": "string", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, - "url": { + "languages_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "html_url": { + "merges_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "followers_url": { + "milestones_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, - "following_url": { + "notifications_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, - "gists_url": { + "pulls_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, - "starred_url": { + "releases_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, - "subscriptions_url": { + "ssh_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "git@github.com:octocat/Hello-World.git" ] }, - "organizations_url": { + "stargazers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "repos_url": { + "statuses_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "events_url": { + "subscribers_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "received_events_url": { + "subscription_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "type": { + "tags_url": { "type": "string", + "format": "uri", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/tags" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "teams_url": { "type": "string", + "format": "uri", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "http://api.github.com/repos/octocat/Hello-World/teams" ] }, - "user_view_type": { + "trees_url": { "type": "string", "examples": [ - "public" + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { + }, + "clone_url": { "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" + "git:git.example.com/octocat/Hello-World" ] }, - "html_url": { + "hooks_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" + "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, - "labels_url": { + "svn_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + "https://svn.github.com/octocat/Hello-World" ] }, - "id": { + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { "type": "integer", "examples": [ - 1002604 + 9 ] }, - "node_id": { + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", "type": "string", "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" + "master" ] }, - "number": { - "description": "The number of the milestone.", + "open_issues_count": { "type": "integer", "examples": [ - 42 + 0 ] }, - "state": { - "description": "The state of the milestone.", + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": [ - "open", - "closed" + "all", + "collaborators_only" ], - "default": "open", "examples": [ - "open" + "all" ] }, - "title": { - "description": "The title of the milestone.", - "type": "string", + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "v1.0" + "2011-01-26T19:06:43Z" ] }, - "description": { + "created_at": { "type": [ "string", "null" ], + "format": "date-time", "examples": [ - "Tracking milestone for version 1.0" + "2011-01-26T19:01:12Z" ] }, - "creator": { - "anyOf": [ - { - "type": "null" + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" ] } + }, + "required": [ + "label", + "ref", + "repo", + "sha", + "user" ] }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { + "_links": { "type": "object", "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "comments": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "commits": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "statuses": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "html": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "issue": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] } }, "required": [ - "diff_url", - "html_url", - "patch_url", - "url" + "comments", + "commits", + "statuses", + "html", + "issue", + "review_comments", + "review_comment", + "self" ] }, - "closed_at": { + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "auto_merge": { + "title": "Auto merge", + "description": "The status of auto merging a pull request.", "type": [ - "string", + "object", "null" ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { + "properties": { + "enabled_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -823139,209 +836706,104 @@ "type", "url" ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." }, - "name": { + "merge_method": { "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", + "description": "The merge method to use.", "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null + "merge", + "squash", + "rebase" ] }, - "created_at": { + "commit_title": { "type": "string", - "description": "The time the issue type created.", - "format": "date-time" + "description": "Title for the merge commit message." }, - "updated_at": { + "commit_message": { "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." + "description": "Commit message for the merge commit." } }, "required": [ - "id", - "node_id", - "name", - "description" + "enabled_by", + "merge_method", + "commit_title", + "commit_message" ] }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean", + "examples": [ + false + ] + } + }, + "required": [ + "_links", + "assignee", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merge_commit_sha", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge" + ] + }, + { + "title": "Draft Issue", + "description": "A draft issue in a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The ID of the draft issue" + }, + "node_id": { + "type": "string", + "description": "The node ID of the draft issue" + }, + "title": { + "type": "string", + "description": "The title of the draft issue" + }, + "body": { + "type": [ + "string", + "null" + ], + "description": "The body content of the draft issue" + }, + "user": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -823508,3157 +836970,3230 @@ "type", "url" ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ], - "examples": [ - "all" - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" ] }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time the draft issue was created" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time the draft issue was last updated" + } + }, + "required": [ + "id", + "node_id", + "title", + "user", + "created_at", + "updated_at" + ] + } + ], + "description": "The content represented by the item." + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the item was archived.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "description": "The URL of the project this item belongs to." + }, + "item_url": { + "type": "string", + "format": "uri", + "description": "The URL of the item in the project." + } + }, + "required": [ + "id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "examples": { + "draft_issue": { + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "drafts" + } + } + }, + "/users": { + "get": { + "summary": "List users", + "description": "Lists all users, in the order that they signed up on GitHub Enterprise Cloud. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.", + "tags": [ + "users" + ], + "operationId": "users/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/users#list-users" + }, + "parameters": [ + { + "name": "since", + "description": "A user ID. Only return users with an ID greater than this ID.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "description": "Not modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" + } + } + }, + "/users/{user_id}/projectsV2/{project_number}/views": { + "post": { + "summary": "Create a view for a user-owned project", + "description": "Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered.", + "tags": [ + "projects" + ], + "operationId": "projects/create-view-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/views#create-a-view-for-a-user-owned-project" + }, + "parameters": [ + { + "name": "user_id", + "description": "The unique identifier of the user.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_number", + "description": "The project's number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the view.", + "examples": [ + "Sprint Board" + ] + }, + "layout": { + "type": "string", + "description": "The layout of the view.", + "enum": [ + "table", + "board", + "roadmap" + ], + "examples": [ + "board" + ] + }, + "filter": { + "type": "string", + "description": "The filter query for the view. See [Filtering projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", + "examples": [ + "is:issue is:open" + ] + }, + "visible_fields": { + "type": "array", + "description": "`visible_fields` is not applicable to `roadmap` layout views.\nFor `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used.", + "items": { + "type": "integer" + }, + "examples": [ + 123, + 456, + 789 + ] + } + }, + "required": [ + "name", + "layout" + ], + "additionalProperties": false + }, + "examples": { + "table_view": { + "summary": "Create a table view", + "value": { + "name": "All Issues", + "layout": "table", + "filter": "is:issue", + "visible_fields": [ + 123, + 456, + 789 + ] + } + }, + "board_view": { + "summary": "Create a board view with filter", + "value": { + "name": "Sprint Board", + "layout": "board", + "filter": "is:issue is:open label:sprint", + "visible_fields": [ + 123, + 456, + 789 + ] + } + }, + "roadmap_view": { + "summary": "Create a roadmap view", + "value": { + "name": "Product Roadmap", + "layout": "roadmap" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response for creating a view in a user-owned project.", + "content": { + "application/json": { + "schema": { + "title": "Projects v2 View", + "description": "A view inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the view." + }, + "number": { + "type": "integer", + "description": "The number of the view within the project." + }, + "name": { + "type": "string", + "description": "The name of the view." + }, + "layout": { + "type": "string", + "description": "The layout of the view.", + "enum": [ + "table", + "board", + "roadmap" + ] + }, + "node_id": { + "type": "string", + "description": "The node ID of the view." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the view.", + "examples": [ + "https://api.github.com/orgs/octocat/projectsV2/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The web URL of the view.", + "examples": [ + "https://github.com/orgs/octocat/projects/1/views/1" + ] + }, + "creator": { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" ] }, - "author_association": { - "title": "author_association", + "login": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], "examples": [ - "OWNER" + "octocat" ] }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 ] }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" ] }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ "string", "null" ], - "format": "uri" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the issue comment", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/comments/1" - ] - }, - "body": { - "description": "Contents of the issue comment", - "type": "string", - "examples": [ - "What version of Safari were you using when you observed this bug?" - ] - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" ] }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" ] }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] - }, - { - "type": "number", - "examples": [ - 42.5 - ] - }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] - }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the view was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the view was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "filter": { + "type": [ + "string", + "null" + ], + "description": "The filter query for the view.", + "examples": [ + "is:issue is:open" + ] + }, + "visible_fields": { + "type": "array", + "description": "The list of field IDs that are visible in the view.", + "items": { + "type": "integer" + } + }, + "sort_by": { + "type": "array", + "description": "The sorting configuration for the view. Each element is a tuple of [field_id, direction] where direction is \"asc\" or \"desc\".", + "items": { + "type": "array", + "minItems": 2, + "maxItems": 2, + "items": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + }, + "group_by": { + "type": "array", + "description": "The list of field IDs used for horizontal grouping.", + "items": { + "type": "integer" + } + }, + "vertical_group_by": { + "type": "array", + "description": "The list of field IDs used for vertical grouping (board layout).", + "items": { + "type": "integer" + } + } + }, + "required": [ + "id", + "number", + "name", + "layout", + "node_id", + "project_url", + "html_url", + "creator", + "created_at", + "updated_at", + "visible_fields", + "sort_by", + "group_by", + "vertical_group_by" + ] + }, + "examples": { + "table_view": { + "summary": "Response for creating a table view", + "value": { + "value": { + "id": 1, + "number": 1, + "name": "Sprint Board", + "layout": "board", + "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", + "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", + "html_url": "https://github.com/orgs/octocat/projects/1/views/1", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "filter": "is:issue is:open", + "visible_fields": [ + 123, + 456, + 789 + ], + "sort_by": [ + [ + 123, + "asc" + ], + [ + 456, + "desc" + ] + ], + "group_by": [ + 123 + ], + "vertical_group_by": [ + 456 + ] + } + } + }, + "board_view": { + "summary": "Response for creating a board view with filter", + "value": { + "value": { + "id": 1, + "number": 1, + "name": "Sprint Board", + "layout": "board", + "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", + "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", + "html_url": "https://github.com/orgs/octocat/projects/1/views/1", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "filter": "is:issue is:open", + "visible_fields": [ + 123, + 456, + 789 + ], + "sort_by": [ + [ + 123, + "asc" + ], + [ + 456, + "desc" + ] + ], + "group_by": [ + 123 + ], + "vertical_group_by": [ + 456 + ] + } + } + }, + "roadmap_view": { + "summary": "Response for creating a roadmap view", + "value": { + "value": { + "id": 1, + "number": 1, + "name": "Sprint Board", + "layout": "board", + "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", + "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", + "html_url": "https://github.com/orgs/octocat/projects/1/views/1", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "filter": "is:issue is:open", + "visible_fields": [ + 123, + 456, + 789 + ], + "sort_by": [ + [ + 123, + "asc" + ], + [ + 456, + "desc" + ] + ], + "group_by": [ + 123 + ], + "vertical_group_by": [ + 456 + ] + } + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } } - } - }, - "required": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "created_at", - "updated_at" + ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "projects", + "subcategory": "views" + } + } + }, + "/users/{username}": { + "get": { + "summary": "Get a user", + "description": "Provides publicly available information about someone with a GitHub account.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/enterprise-cloud@latest/rest/users/emails).", + "tags": [ + "users" + ], + "operationId": "users/get-by-username", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/users#get-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "octocat" ] }, - { - "title": "Pull Request Simple", - "description": "Pull Request Simple", + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "user_view_type": { + "type": "string" + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "plan": { "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/1347" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOlB1bGxSZXF1ZXN0MQ==" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/pull/1347" - ] - }, - "diff_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/pull/1347.diff" - ] - }, - "patch_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/pull/1347.patch" - ] - }, - "issue_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - }, - "commits_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" - ] - }, - "review_comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" - ] - }, - "review_comment_url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" - ] - }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" - ] + "collaborators": { + "type": "integer" }, - "statuses_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] + "name": { + "type": "string" }, - "number": { - "type": "integer", - "examples": [ - 1347 - ] + "space": { + "type": "integer" }, - "state": { - "type": "string", - "examples": [ - "open" - ] + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "user_view_type": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" + ] + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ] + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" }, - "locked": { - "type": "boolean", - "examples": [ - true - ] + "name": { + "type": "string" }, - "title": { - "type": "string", - "examples": [ - "new-feature" - ] + "space": { + "type": "integer" }, - "user": { - "anyOf": [ - { - "type": "null" + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 1 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 3 + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + } + ] + }, + "examples": { + "default-response": { + "summary": "Default response", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "response-with-git-hub-plan-information": { + "summary": "Response with GitHub plan information", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "plan": { + "name": "pro", + "space": 976562499, + "collaborators": 0, + "private_repos": 9999 + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" + } + } + }, + "/users/{username}/attestations/bulk-list": { + "post": { + "summary": "List attestations by bulk subject digests", + "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "users" + ], + "operationId": "users/list-attestations-bulk", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/attestations#list-attestations-by-bulk-subject-digests" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "subject_digests": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of subject digests to fetch attestations for.", + "minItems": 1, + "maxItems": 1024 + }, + "predicate_type": { + "type": "string", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types." + } + }, + "required": [ + "subject_digests" + ] + }, + "examples": { + "default": { + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ] + } + }, + "withPredicateType": { + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ], + "predicateType": "provenance" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations_subject_digests": { + "type": "object", + "additionalProperties": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" }, - { - "title": "Simple User", - "description": "A GitHub user.", + "verificationMaterial": { "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true } - ] + }, + "description": "The bundle of the attestation." }, - "body": { - "type": [ - "string", - "null" - ], - "examples": [ - "Please pull these awesome changes" - ] + "repository_id": { + "type": "integer" }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" + "bundle_url": { + "type": "string" + } + } + } + }, + "description": "Mapping of subject digest to bundles." + }, + "page_info": { + "type": "object", + "properties": { + "has_next": { + "type": "boolean", + "description": "Indicates whether there is a next page." + }, + "has_previous": { + "type": "boolean", + "description": "Indicates whether there is a previous page." + }, + "next": { + "type": "string", + "description": "The cursor to the next page." + }, + "previous": { + "type": "string", + "description": "The cursor to the previous page." + } + }, + "description": "Information about the current page." + } + } + }, + "examples": { + "default": { + "value": { + "attestations_subject_digests": [ + { + "sha256:abc": [ + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" } }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + } + ] + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + } + } + }, + "/users/{username}/attestations/delete-request": { + "post": { + "summary": "Delete attestations in bulk", + "description": "Delete artifact attestations in bulk by either subject digests or unique ID.", + "tags": [ + "users" + ], + "operationId": "users/delete-attestations-bulk", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/attestations#delete-attestations-in-bulk" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "oneOf": [ + { + "properties": { + "subject_digests": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of subject digests associated with the artifact attestations to delete.", + "minItems": 1, + "maxItems": 1024 + } + }, + "required": [ + "subject_digests" + ] + }, + { + "properties": { + "attestation_ids": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of unique IDs associated with the artifact attestations to delete.", + "minItems": 1, + "maxItems": 1024 + } + }, + "required": [ + "attestation_ids" + ] + } + ], + "description": "The request body must include either `subject_digests` or `attestation_ids`, but not both." + }, + "examples": { + "by-subject-digests": { + "summary": "Delete by subject digests", + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ] + } + }, + "by-attestation-ids": { + "summary": "Delete by attestation IDs", + "value": { + "attestation_ids": [ + 111, + 222 + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + } + } + }, + "/users/{username}/attestations/digest/{subject_digest}": { + "delete": { + "summary": "Delete attestations by subject digest", + "description": "Delete an artifact attestation by subject digest.", + "tags": [ + "users" + ], + "operationId": "users/delete-attestations-by-subject-digest", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/attestations#delete-attestations-by-subject-digest" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "subject_digest", + "description": "Subject Digest", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "responses": { + "200": { + "description": "Response" + }, + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + } + } + }, + "/users/{username}/attestations/{attestation_id}": { + "delete": { + "summary": "Delete attestations by ID", + "description": "Delete an artifact attestation by unique ID that is associated with a repository owned by a user.", + "tags": [ + "users" + ], + "operationId": "users/delete-attestations-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/attestations#delete-attestations-by-id" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "attestation_id", + "description": "Attestation ID", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response" + }, + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + } + } + }, + "/users/{username}/attestations/{subject_digest}": { + "get": { + "summary": "List attestations", + "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "users" + ], + "operationId": "users/list-attestations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/attestations#list-attestations" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "subject_digest", + "description": "Subject Digest", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." + }, + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + }, + "initiator": { + "type": "string" + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "attestations": [ + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" } }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ] + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "examples": [ - "too heated" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "merge_commit_sha": { - "type": [ - "string", - "null" ], - "examples": [ - "e5bd3914e2e596debea16f433f57875b5b90bcd6" - ] + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } }, - "assignee": { - "anyOf": [ + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ { - "type": "null" - }, + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + }, + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" } }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" } - ] + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } }, - "assignees": { - "type": "array", - "items": { + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + } + ] + } + } + } + } + } + }, + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + } + } + }, + "/users/{username}/copilot-spaces": { + "get": { + "summary": "List Copilot Spaces for a user", + "description": "Lists Copilot Spaces owned by a user. The authenticated user must have read access to the user's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes the user's own spaces, and public user spaces when accessing another user's spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/list-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/copilot-spaces#list-copilot-spaces-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "spaces" + ], + "properties": { + "spaces": { + "type": "array", + "description": "The list of Copilot Spaces on this page of results.", + "items": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { + "anyOf": [ + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -826825,36 +840360,20 @@ "type", "url" ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, "login": { "type": "string", "examples": [ - "octocat" + "github" ] }, "id": { "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -826862,3340 +840381,2875 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/orgs/github/repos" ] }, "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "https://api.github.com/orgs/github/events" ] }, - "user_view_type": { + "hooks_url": { "type": "string", "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" + "https://api.github.com/orgs/github/hooks" ] }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { + "issues_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/orgs/rails/teams/core" + "https://api.github.com/orgs/github/issues" ] }, "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ], - "examples": [ - "all" - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "sha": { - "type": "string" + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - } + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "base": { + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { "type": "object", "properties": { - "label": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." }, - "ref": { - "type": "string" + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { "type": "object", + "description": "Metadata specific to the resource type.", "properties": { - "id": { - "description": "Unique identifier of the repository", + "repository_id": { "type": "integer", - "format": "int64", - "examples": [ - 42 - ] + "description": "Repository ID for repository or file resources." }, - "node_id": { + "file_path": { "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "description": "File path for file resources." }, - "name": { - "description": "The name of the repository.", + "text": { "type": "string", - "examples": [ - "Team Environment" - ] + "description": "Text content for free text resources." }, - "full_name": { + "name": { "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "description": "Name for the resource." }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "number": { + "type": "integer", + "description": "Issue or PR number." }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." }, - "html_url": { + "media_type": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" + "description": "Media type for media content resources." }, "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] + "description": "URL for media content resources." }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "height": { "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] + "description": "Height for media content resources." }, - "open_issues_count": { + "width": { "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ], - "examples": [ - "all" - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } + "description": "Width for media content resources." } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "sha": { + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + } + } + } + }, + "examples": { + "default": { + "summary": "Example response for listing user copilot spaces", + "value": { + "spaces": [ + { + "id": 42, + "number": 1, + "name": "Personal Research Space", + "description": "My personal space for research and development", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-16T10:15:00Z", + "updated_at": "2023-02-16T16:30:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/1", + "api_url": "https://api.github.com/user/1/copilot-spaces/1" + }, + { + "id": 43, + "number": 2, + "name": "Learning Space", + "description": "Space for learning new technologies", + "owner": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjM=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-17T08:20:00Z", + "updated_at": "2023-02-17T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/2", + "api_url": "https://api.github.com/user/1/copilot-spaces/2" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "post": { + "summary": "Create a Copilot Space for a user", + "description": "Creates a new Copilot Space owned by a user. Only the authenticated user can create spaces for their own account.\n\nUsers can create personal Copilot Spaces for their individual use.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/create-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/copilot-spaces#create-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Personal space for development assistance" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help me with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "no_access" + ], + "description": "The base role that determines default permissions for the space.\n- `no_access`: No default access (default)\n- `reader`: Makes the space publicly readable\nNote: User spaces do not support writer or admin base roles.", + "default": "no_access" + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "My Development Space", + "description": "Personal space for development assistance", + "general_instructions": "Help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/App.js" + } + }, + { + "resource_type": "free_text", + "metadata": { + "name": "Development Notes", + "text": "Focus on clean code principles and modern React patterns" + } + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + }, + "examples": { + "default": { + "summary": "Example response for a user copilot space", + "value": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}": { + "get": { + "summary": "Get a Copilot Space for a user", + "description": "Gets details about a specific Copilot Space owned by a user. The authenticated user must have read access to the Space.\n\nPrivate user spaces require the authenticated user to be the owner of the space.\nPublic user spaces are accessible to any authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/get-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/copilot-spaces#get-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" + "email": { + "type": [ + "string", + "null" ] }, - "author_association": { - "title": "author_association", + "login": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], "examples": [ - "OWNER" + "octocat" ] }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "object", + "string", "null" ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" ] }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean", + "url": { + "type": "string", + "format": "uri", "examples": [ - false + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", "html_url", "id", "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", "url", - "user", - "author_association", - "auto_merge" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ], + "description": "The user or organization that owns this space." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was created.", + "examples": [ + "2023-01-01T00:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the space was last updated.", + "examples": [ + "2023-01-01T12:00:00Z" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", + "examples": [ + "https://github.com/copilot/spaces/octo-org/5" + ] + }, + "api_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] + }, + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } + } + }, + "required": [ + "id", + "number", + "name", + "base_role", + "owner", + "creator", + "created_at", + "updated_at", + "html_url", + "api_url" + ], + "additionalProperties": false + }, + "examples": { + "default": { + "summary": "Example response for a user copilot space", + "value": { + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, { - "title": "Draft Issue", - "description": "A draft issue in a project", + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "put": { + "summary": "Set a Copilot Space for a user", + "description": "Updates a Copilot Space owned by a user. Only the authenticated user can update spaces for their own account.\n\nUsers can update their personal Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/copilot-spaces#set-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Copilot Space.", + "examples": [ + "Updated Development Space" + ] + }, + "description": { + "type": "string", + "description": "A description of the Copilot Space.", + "examples": [ + "Updated personal space for development assistance" + ] + }, + "general_instructions": { + "type": "string", + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Updated instructions to help me with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "no_access" + ], + "description": "The base role that determines default permissions for the space. Changing this field requires admin permissions.\n- `no_access`: No default access (default)\n- `reader`: Makes the space publicly readable\nNote: User spaces do not support writer or admin base roles." + }, + "resources_attributes": { + "type": "array", + "description": "Resources to attach to the space.", + "items": { + "type": "object", + "properties": { + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + } + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "Updated Development Space", + "description": "Updated personal space for development assistance", + "general_instructions": "Updated instructions to help me with React development patterns and best practices", + "resources_attributes": [ + { + "resource_type": "github_file", + "metadata": { + "repository_id": 789012, + "file_path": "src/components/UpdatedApp.js" + } + }, + { + "id": 123, + "_destroy": true + }, + { + "id": 456, + "resource_type": "free_text", + "metadata": { + "name": "Updated Development Notes", + "text": "Updated focus on clean code principles and modern React patterns" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Space", + "description": "A GitHub Copilot Space represents an interactive AI workspace where users can ask questions and get assistance.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the space.", + "examples": [ + 42 + ] + }, + "number": { + "type": "integer", + "description": "The number that identifies the space within its owner.", + "examples": [ + 1 + ] + }, + "name": { + "type": "string", + "description": "The display name of the space.", + "examples": [ + "My Development Space" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A description of the space.", + "examples": [ + "A space for discussing React development patterns" + ] + }, + "general_instructions": { + "type": [ + "string", + "null" + ], + "maxLength": 4000, + "description": "General instructions for the Copilot Space.", + "examples": [ + "Help with React development patterns and best practices" + ] + }, + "base_role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The base role that determines default permissions.\n- `no_access`: No default access\n- `reader`: Default read permissions\n- `writer`: Default write permissions (organization spaces only)\n- `admin`: Default admin permissions (organization spaces only)", + "examples": [ + "no_access" + ] + }, + "owner": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { - "type": "number", - "description": "The ID of the draft issue" + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] }, "node_id": { "type": "string", - "description": "The node ID of the draft issue" + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "title": { + "avatar_url": { "type": "string", - "description": "The title of the draft issue" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "body": { + "gravatar_id": { "type": [ "string", "null" ], - "description": "The body content of the draft issue" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "created_at": { + "subscriptions_url": { "type": "string", - "format": "date-time", - "description": "The time the draft issue was created" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "updated_at": { + "organizations_url": { "type": "string", - "format": "date-time", - "description": "The time the draft issue was last updated" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "title", - "user", - "created_at", - "updated_at" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" ] } ], - "description": "The content represented by the item." - }, - "content_type": { - "title": "Projects v2 Item Content Type", - "description": "The type of content tracked in a project item", - "type": "string", - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] + "description": "The user or organization that owns this space." }, "creator": { "title": "Simple User", @@ -830368,83 +843422,170 @@ "created_at": { "type": "string", "format": "date-time", - "description": "The time when the item was created.", + "description": "The date and time the space was created.", "examples": [ - "2022-04-28T12:00:00Z" + "2023-01-01T00:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", - "description": "The time when the item was last updated.", + "description": "The date and time the space was last updated.", "examples": [ - "2022-04-28T12:00:00Z" + "2023-01-01T12:00:00Z" ] }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time when the item was archived.", + "html_url": { + "type": "string", + "format": "uri", + "description": "The HTML URL of the space.", "examples": [ - "2022-04-28T12:00:00Z" + "https://github.com/copilot/spaces/octo-org/5" ] }, - "project_url": { + "api_url": { "type": "string", "format": "uri", - "description": "The URL of the project this item belongs to." + "description": "The API URL of the space.", + "examples": [ + "https://api.github.com/organizations/1/copilot-spaces/5" + ] }, - "item_url": { - "type": "string", - "format": "uri", - "description": "The URL of the item in the project." + "resources_attributes": { + "type": "array", + "description": "Resources attached to the space.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ], + "description": "The type of resource." + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "The unique identifier of the chat attachment for uploaded files or media content." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + }, + "metadata": { + "type": "object", + "description": "Metadata specific to the resource type.", + "properties": { + "repository_id": { + "type": "integer", + "description": "Repository ID for repository or file resources." + }, + "file_path": { + "type": "string", + "description": "File path for file resources." + }, + "text": { + "type": "string", + "description": "Text content for free text resources." + }, + "name": { + "type": "string", + "description": "Name for the resource." + }, + "number": { + "type": "integer", + "description": "Issue or PR number." + }, + "copilot_chat_attachment_id": { + "type": "integer", + "description": "Chat attachment ID for uploaded files or media." + }, + "media_type": { + "type": "string", + "description": "Media type for media content resources." + }, + "url": { + "type": "string", + "description": "URL for media content resources." + }, + "height": { + "type": "integer", + "description": "Height for media content resources." + }, + "width": { + "type": "integer", + "description": "Width for media content resources." + } + } + } + } + } } }, "required": [ "id", - "content_type", + "number", + "name", + "base_role", + "owner", + "creator", "created_at", "updated_at", - "archived_at" - ] + "html_url", + "api_url" + ], + "additionalProperties": false }, "examples": { - "draft_issue": { + "default": { + "summary": "Example response for a user copilot space", "value": { - "id": 17, - "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", - "content": { - "id": 38, - "node_id": "I_kwDOANN5s85FtLts", - "title": "Example Draft Issue", - "body": "This is a draft issue in the project.", - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } + "id": 42, + "number": 5, + "name": "My Development Space", + "description": "Personal space for React development patterns", + "general_instructions": "Focus on React functional components, hooks, and modern development patterns", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false }, - "content_type": "DraftIssue", "creator": { "login": "octocat", "id": 1, @@ -830465,20 +843606,35 @@ "type": "User", "site_admin": false }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "archived_at": null, - "project_url": "https://api.github.com/users/octocat/projectsV2/1", - "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + "created_at": "2023-02-15T08:30:00Z", + "updated_at": "2023-02-15T14:45:00Z", + "html_url": "https://github.com/copilot/spaces/octocat/5", + "api_url": "https://api.github.com/user/1/copilot-spaces/5", + "base_role": "no_access", + "resources_attributes": [ + { + "id": 789, + "resource_type": "github_file", + "metadata": { + "repository_id": 1234, + "file_path": "src/components/App.tsx" + } + }, + { + "id": 790, + "resource_type": "free_text", + "metadata": { + "name": "React Best Practices", + "text": "Use functional components with hooks" + } + } + ] } } } } } }, - "304": { - "description": "Not modified" - }, "403": { "description": "Forbidden", "content": { @@ -830505,8 +843661,8 @@ } } }, - "401": { - "description": "Requires authentication", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -830530,45 +843686,262 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects", - "subcategory": "drafts" + "category": "copilot-spaces", + "subcategory": "copilot-spaces" + } + }, + "delete": { + "summary": "Delete a Copilot Space for a user", + "description": "Deletes a Copilot Space owned by a user. The authenticated user must be the owner of the space.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a space will remove all associated resources and configurations.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/delete-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/copilot-spaces#delete-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "The Copilot Space has been successfully deleted." + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "copilot-spaces" } } }, - "/users": { + "/users/{username}/copilot-spaces/{space_number}/collaborators": { "get": { - "summary": "List users", - "description": "Lists all users, in the order that they signed up on GitHub Enterprise Cloud. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.", + "summary": "List collaborators for a Copilot Space for a user", + "description": "Lists all collaborators for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nEach collaborator entry specifies which user has access to the space and at what level (reader, writer, or admin). The space owner is excluded from this list.\n\nTeam collaborators are not supported for user-owned Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/list", + "operationId": "copilot-spaces/list-collaborators-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/collaborators#list-collaborators-for-a-copilot-space-for-a-user" }, "parameters": [ { - "name": "since", - "description": "A user ID. Only return users with an ID greater than this ID.", - "in": "query", - "required": false, + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "integer" } } ], @@ -830578,241 +843951,463 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" + "type": "object", + "required": [ + "collaborators" + ], + "properties": { + "collaborators": { + "type": "array", + "description": "The list of collaborators for this Copilot Space.", + "items": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } ] } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + } } }, "examples": { "default": { - "value": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ] + "value": { + "collaborators": [ + { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + }, + { + "actor_type": "User", + "role": "reader", + "login": "github-user", + "id": 67890, + "node_id": "MDQ6VXNlcjY3ODkw", + "avatar_url": "https://github.com/images/error/other_user.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github-user", + "html_url": "https://github.com/github-user", + "followers_url": "https://api.github.com/users/github-user/followers", + "following_url": "https://api.github.com/users/github-user/following{/other_user}", + "gists_url": "https://api.github.com/users/github-user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github-user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github-user/subscriptions", + "organizations_url": "https://api.github.com/users/github-user/orgs", + "repos_url": "https://api.github.com/users/github-user/repos", + "events_url": "https://api.github.com/users/github-user/events{/privacy}", + "received_events_url": "https://api.github.com/users/github-user/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "GitHub User", + "company": null, + "blog": "", + "location": null, + "email": null, + "hireable": null, + "bio": null, + "twitter_username": null, + "public_repos": 5, + "public_gists": 0, + "followers": 10, + "following": 5, + "created_at": "2010-01-14T04:33:35Z", + "updated_at": "2010-01-14T04:33:35Z" + } + ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\"", + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } } } } }, - "304": { - "description": "Not modified" + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "users" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" } - } - }, - "/users/{user_id}/projectsV2/{project_number}/views": { + }, "post": { - "summary": "Create a view for a user-owned project", - "description": "Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered.", + "summary": "Add a collaborator to a Copilot Space for a user", + "description": "Adds a collaborator to a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nTeam collaborators are not supported for user-owned Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", "tags": [ - "projects" + "copilot-spaces" ], - "operationId": "projects/create-view-for-user", + "operationId": "copilot-spaces/add-collaborator-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/views#create-a-view-for-a-user-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/collaborators#add-a-collaborator-to-a-copilot-space-for-a-user" }, "parameters": [ { - "name": "user_id", - "description": "The unique identifier of the user.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { @@ -830820,8 +844415,8 @@ } }, { - "name": "project_number", - "description": "The project's number.", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { @@ -830835,84 +844430,41 @@ "application/json": { "schema": { "type": "object", + "required": [ + "actor_type", + "actor_identifier", + "role" + ], "properties": { - "name": { - "type": "string", - "description": "The name of the view.", - "examples": [ - "Sprint Board" - ] - }, - "layout": { + "actor_type": { "type": "string", - "description": "The layout of the view.", "enum": [ - "table", - "board", - "roadmap" + "User", + "Team" ], - "examples": [ - "board" - ] + "description": "The type of actor (must be `User` for user-owned spaces; `Team` will be rejected)." }, - "filter": { + "actor_identifier": { "type": "string", - "description": "The filter query for the view. See [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", - "examples": [ - "is:issue is:open" - ] + "description": "The username of the collaborator. The numeric user ID is also accepted." }, - "visible_fields": { - "type": "array", - "description": "`visible_fields` is not applicable to `roadmap` layout views.\nFor `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used.", - "items": { - "type": "integer" - }, - "examples": [ - 123, - 456, - 789 - ] + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role to grant to the collaborator." } - }, - "required": [ - "name", - "layout" - ], - "additionalProperties": false + } }, "examples": { - "table_view": { - "summary": "Create a table view", - "value": { - "name": "All Issues", - "layout": "table", - "filter": "is:issue", - "visible_fields": [ - 123, - 456, - 789 - ] - } - }, - "board_view": { - "summary": "Create a board view with filter", - "value": { - "name": "Sprint Board", - "layout": "board", - "filter": "is:issue is:open label:sprint", - "visible_fields": [ - 123, - 456, - 789 - ] - } - }, - "roadmap_view": { - "summary": "Create a roadmap view", + "default": { "value": { - "name": "Product Roadmap", - "layout": "roadmap" + "actor_type": "User", + "actor_identifier": "octocat", + "role": "writer" } } } @@ -830921,55 +844473,15 @@ }, "responses": { "201": { - "description": "Response for creating a view in a user-owned project.", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Projects v2 View", - "description": "A view inside a projects v2 project", + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the view." - }, - "number": { - "type": "integer", - "description": "The number of the view within the project." - }, - "name": { - "type": "string", - "description": "The name of the view." - }, - "layout": { - "type": "string", - "description": "The layout of the view.", - "enum": [ - "table", - "board", - "roadmap" - ] - }, - "node_id": { - "type": "string", - "description": "The node ID of the view." - }, - "project_url": { - "type": "string", - "description": "The API URL of the project that contains the view.", - "examples": [ - "https://api.github.com/orgs/octocat/projectsV2/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The web URL of the view.", - "examples": [ - "https://github.com/orgs/octocat/projects/1/views/1" - ] - }, - "creator": { + "anyOf": [ + { "allOf": [ { "title": "Simple User", @@ -831138,274 +844650,722 @@ "type", "url" ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" + ] } ] }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The time when the view was created.", - "examples": [ - "2022-04-28T12:00:00Z" + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" ] + } + ] + }, + "examples": { + "default": { + "value": { + "actor_type": "User", + "role": "writer", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The time when the view was last updated.", - "examples": [ - "2022-04-28T12:00:00Z" - ] + "documentation_url": { + "type": "string" }, - "filter": { - "type": [ - "string", - "null" - ], - "description": "The filter query for the view.", - "examples": [ - "is:issue is:open" - ] + "url": { + "type": "string" }, - "visible_fields": { - "type": "array", - "description": "The list of field IDs that are visible in the view.", - "items": { - "type": "integer" - } + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "sort_by": { - "type": "array", - "description": "The sorting configuration for the view. Each element is a tuple of [field_id, direction] where direction is \"asc\" or \"desc\".", - "items": { - "type": "array", - "minItems": 2, - "maxItems": 2, - "items": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string" - } - ] - } - } + "documentation_url": { + "type": "string" }, - "group_by": { - "type": "array", - "description": "The list of field IDs used for horizontal grouping.", - "items": { - "type": "integer" - } + "url": { + "type": "string" }, - "vertical_group_by": { + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", - "description": "The list of field IDs used for vertical grouping (board layout).", "items": { - "type": "integer" + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } } } - }, - "required": [ - "id", - "number", - "name", - "layout", - "node_id", - "project_url", - "html_url", - "creator", - "created_at", - "updated_at", - "visible_fields", - "sort_by", - "group_by", - "vertical_group_by" - ] - }, - "examples": { - "table_view": { - "summary": "Response for creating a table view", - "value": { - "value": { - "id": 1, - "number": 1, - "name": "Sprint Board", - "layout": "board", - "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", - "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", - "html_url": "https://github.com/orgs/octocat/projects/1/views/1", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + } + }, + "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { + "put": { + "summary": "Set a collaborator role for a Copilot Space for a user", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/update-collaborator-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "The type of actor (must be `User` for user-owned spaces; `Team` will be rejected).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username of the collaborator. The numeric user ID is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "role" + ], + "properties": { + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin", + "no_access" + ], + "description": "The new role to grant to the collaborator. Use `no_access` to remove the collaborator." + } + } + }, + "examples": { + "default": { + "value": { + "role": "admin" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Copilot Space Collaborator", + "description": "A collaborator (user or team) of a Copilot Space", + "type": "object", + "anyOf": [ + { + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "filter": "is:issue is:open", - "visible_fields": [ - 123, - 456, - 789 - ], - "sort_by": [ - [ - 123, - "asc" - ], - [ - 456, - "desc" + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "User" + ], + "description": "The collaborator actor type." + }, + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" + ], + "description": "The role granted to the collaborator" + } + }, + "required": [ + "actor_type", + "role" ] - ], - "group_by": [ - 123 - ], - "vertical_group_by": [ - 456 - ] - } - } - }, - "board_view": { - "summary": "Response for creating a board view with filter", - "value": { - "value": { - "id": 1, - "number": 1, - "name": "Sprint Board", - "layout": "board", - "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", - "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", - "html_url": "https://github.com/orgs/octocat/projects/1/views/1", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + } + ] + }, + { + "type": "object", + "properties": { + "actor_type": { + "type": "string", + "enum": [ + "Team" + ], + "description": "The collaborator actor type." }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "filter": "is:issue is:open", - "visible_fields": [ - 123, - 456, - 789 - ], - "sort_by": [ - [ - 123, - "asc" + "role": { + "type": "string", + "enum": [ + "reader", + "writer", + "admin" ], - [ - 456, - "desc" + "description": "The role granted to the collaborator" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Team" ] - ], - "group_by": [ - 123 - ], - "vertical_group_by": [ - 456 - ] - } - } - }, - "roadmap_view": { - "summary": "Response for creating a roadmap view", - "value": { - "value": { - "id": 1, - "number": 1, - "name": "Sprint Board", - "layout": "board", - "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", - "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", - "html_url": "https://github.com/orgs/octocat/projects/1/views/1", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "filter": "is:issue is:open", - "visible_fields": [ - 123, - 456, - 789 - ], - "sort_by": [ - [ - 123, - "asc" - ], - [ - 456, - "desc" + "description": { + "type": [ + "string", + "null" ] - ], - "group_by": [ - 123 - ], - "vertical_group_by": [ - 456 - ] - } + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_id": { + "type": "integer" + }, + "parent": { + "type": [ + "null" + ] + } + }, + "required": [ + "actor_type", + "role", + "id", + "node_id", + "name", + "slug", + "type" + ] + } + ] + }, + "examples": { + "default": { + "value": { + "actor_type": "User", + "role": "admin", + "login": "octocat", + "id": 12345, + "node_id": "MDQ6VXNlcjEyMzQ1", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false, + "name": "The Octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "octocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" } } } } } }, - "304": { - "description": "Not modified" + "204": { + "description": "Response when `role` is `no_access` and the collaborator was removed." }, "403": { "description": "Forbidden", @@ -831433,32 +845393,6 @@ } } }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, "404": { "description": "Resource not found", "content": { @@ -831559,9 +845493,99 @@ } } } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "collaborators" + } + }, + "delete": { + "summary": "Remove a collaborator from a Copilot Space for a user", + "description": "Removes a collaborator from a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "copilot-spaces" + ], + "operationId": "copilot-spaces/remove-collaborator-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/collaborators#remove-a-collaborator-from-a-copilot-space-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "503": { - "description": "Service unavailable", + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "actor_type", + "description": "The type of actor (must be `User` for user-owned spaces; `Team` will be rejected).", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + }, + { + "name": "actor_identifier", + "description": "The username of the collaborator. The numeric user ID is also accepted.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -831588,24 +845612,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": false, - "category": "projects", - "subcategory": "views" + "category": "copilot-spaces", + "subcategory": "collaborators" } } }, - "/users/{username}": { + "/users/{username}/copilot-spaces/{space_number}/resources": { "get": { - "summary": "Get a user", - "description": "Provides publicly available information about someone with a GitHub account.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest//enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/enterprise-cloud@latest//rest/users/emails).", + "summary": "List resources for a Copilot Space for a user", + "description": "Lists all resources attached to a specific Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/get-by-username", + "operationId": "copilot-spaces/list-resources-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/resources#list-resources-for-a-copilot-space-for-a-user" }, "parameters": [ { @@ -831616,6 +845639,15 @@ "schema": { "type": "string" } + }, + { + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { @@ -831624,676 +845656,112 @@ "content": { "application/json": { "schema": { - "oneOf": [ - { - "title": "Private User", - "description": "Private User", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ], - "examples": [ - "monalisa octocat" - ] - }, - "company": { - "type": [ - "string", - "null" - ], - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": [ - "string", - "null" - ], - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ], - "examples": [ - "There once was..." - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "monalisa" - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "private_gists": { - "type": "integer", - "examples": [ - 81 - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "disk_usage": { - "type": "integer", - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": "integer", - "examples": [ - 8 - ] - }, - "two_factor_authentication": { - "type": "boolean", - "examples": [ - true - ] - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } + "type": "object", + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "description": "The list of resources attached to this Copilot Space.", + "items": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "business_plus": { - "type": "boolean" - }, - "ldap_dn": { - "type": "string" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at", - "collaborators", - "disk_usage", - "owned_private_repos", - "private_gists", - "total_private_repos", - "two_factor_authentication" - ] - }, - { - "title": "Public User", - "description": "Public User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "private_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "disk_usage": { - "type": "integer", - "examples": [ - 1 - ] + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } }, - "collaborators": { - "type": "integer", - "examples": [ - 3 - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + } } - ] + } }, "examples": { - "default-response": { - "summary": "Default response", + "default": { "value": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z" + "resources": [ + { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + ] } - }, - "response-with-git-hub-plan-information": { - "summary": "Response with GitHub plan information", - "value": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z", - "plan": { - "name": "pro", - "space": 976562499, - "collaborators": 0, - "private_repos": 9999 - } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -832328,60 +845796,39 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "users" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/users/{username}/attestations/bulk-list": { + }, "post": { - "summary": "List attestations by bulk subject digests", - "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "summary": "Create a resource for a Copilot Space for a user", + "description": "Creates a new resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/list-attestations-bulk", + "operationId": "copilot-spaces/create-resource-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations-by-bulk-subject-digests" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/resources#create-a-resource-for-a-copilot-space-for-a-user" }, "parameters": [ { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, "schema": { "type": "string" } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -832391,41 +845838,55 @@ "application/json": { "schema": { "type": "object", + "required": [ + "resource_type", + "metadata" + ], "properties": { - "subject_digests": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of subject digests to fetch attestations for.", - "minItems": 1, - "maxItems": 1024 - }, - "predicate_type": { + "resource_type": { "type": "string", - "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types." + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request" + ], + "description": "The type of resource to create." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata.", + "additionalProperties": true } - }, - "required": [ - "subject_digests" - ] + } }, "examples": { - "default": { + "free_text": { "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" - ] + "resource_type": "free_text", + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + } } }, - "withPredicateType": { + "repository": { "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" - ], - "predicateType": "provenance" + "resource_type": "repository", + "metadata": { + "repository_id": 42 + } + } + }, + "github_file": { + "value": { + "resource_type": "github_file", + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + } } } } @@ -832433,314 +845894,182 @@ } }, "responses": { - "200": { - "description": "Response", + "201": { + "description": "Resource created", "content": { "application/json": { "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", "type": "object", "properties": { - "attestations_subject_digests": { - "type": "object", - "additionalProperties": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "bundle": { - "type": "object", - "properties": { - "mediaType": { - "type": "string" - }, - "verificationMaterial": { - "type": "object", - "properties": {}, - "additionalProperties": true - }, - "dsseEnvelope": { - "type": "object", - "properties": {}, - "additionalProperties": true - } - }, - "description": "The bundle of the attestation." - }, - "repository_id": { - "type": "integer" - }, - "bundle_url": { - "type": "string" - } - } - } - }, - "description": "Mapping of subject digest to bundles." + "id": { + "type": "integer", + "description": "The unique identifier of the resource." }, - "page_info": { + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { "type": "object", - "properties": { - "has_next": { - "type": "boolean", - "description": "Indicates whether there is a next page." - }, - "has_previous": { - "type": "boolean", - "description": "Indicates whether there is a previous page." - }, - "next": { - "type": "string", - "description": "The cursor to the next page." - }, - "previous": { - "type": "string", - "description": "The cursor to the previous page." - } + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" }, - "description": "Information about the current page." + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" } } + } + } + } + }, + "200": { + "description": "Duplicate github_file resource already exists", + "content": { + "application/json": { + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] }, "examples": { "default": { "value": { - "attestations_subject_digests": [ - { - "sha256:abc": [ - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - }, - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - } - ] - } - ] + "id": 1, + "resource_type": "github_file", + "copilot_chat_attachment_id": null, + "metadata": { + "repository_id": 42, + "file_path": "README.md", + "sha": "abc123" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "attestations" - } - } - }, - "/users/{username}/attestations/delete-request": { - "post": { - "summary": "Delete attestations in bulk", - "description": "Delete artifact attestations in bulk by either subject digests or unique ID.", - "tags": [ - "users" - ], - "operationId": "users/delete-attestations-bulk", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-in-bulk" - }, - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "oneOf": [ - { - "properties": { - "subject_digests": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of subject digests associated with the artifact attestations to delete.", - "minItems": 1, - "maxItems": 1024 - } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "required": [ - "subject_digests" - ] - }, - { - "properties": { - "attestation_ids": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "List of unique IDs associated with the artifact attestations to delete.", - "minItems": 1, - "maxItems": 1024 - } + "documentation_url": { + "type": "string" }, - "required": [ - "attestation_ids" - ] - } - ], - "description": "The request body must include either `subject_digests` or `attestation_ids`, but not both." - }, - "examples": { - "by-subject-digests": { - "summary": "Delete by subject digests", - "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" - ] - } - }, - "by-attestation-ids": { - "summary": "Delete by attestation IDs", - "value": { - "attestation_ids": [ - 111, - 222 - ] + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } } } } - } - }, - "responses": { - "200": { - "description": "Response" }, "404": { "description": "Resource not found", @@ -832767,27 +846096,101 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "attestations" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" } } }, - "/users/{username}/attestations/digest/{subject_digest}": { - "delete": { - "summary": "Delete attestations by subject digest", - "description": "Delete an artifact attestation by subject digest.", + "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}": { + "get": { + "summary": "Get a resource for a Copilot Space for a user", + "description": "Gets a specific resource attached to a Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/delete-attestations-by-subject-digest", + "operationId": "copilot-spaces/get-resource-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-subject-digest" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/resources#get-a-resource-for-a-copilot-space-for-a-user" }, "parameters": [ { @@ -832800,22 +846203,125 @@ } }, { - "name": "subject_digest", - "description": "Subject Digest", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { - "type": "string" - }, - "x-multi-segment": true + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { "200": { - "description": "Response" + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "notes.txt", + "text": "Some helpful notes" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } }, - "204": { - "description": "Response" + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } }, "404": { "description": "Resource not found", @@ -832845,24 +846351,21 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "attestations" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/users/{username}/attestations/{attestation_id}": { - "delete": { - "summary": "Delete attestations by ID", - "description": "Delete an artifact attestation by unique ID that is associated with a repository owned by a user.", + }, + "put": { + "summary": "Set a resource for a Copilot Space for a user", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/delete-attestations-by-id", + "operationId": "copilot-spaces/update-resource-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-id" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/resources#set-a-resource-for-a-copilot-space-for-a-user" }, "parameters": [ { @@ -832875,8 +846378,17 @@ } }, { - "name": "attestation_id", - "description": "Attestation ID", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "space_resource_id", + "description": "The unique identifier of the resource.", "in": "path", "required": true, "schema": { @@ -832884,12 +846396,108 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "Updated resource-specific metadata.", + "additionalProperties": true + } + } + }, + "examples": { + "default": { + "value": { + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + } + } + } + } + } + } + }, "responses": { "200": { - "description": "Response" - }, - "204": { - "description": "Response" + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Copilot Space Resource", + "description": "A resource attached to a Copilot Space.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the resource." + }, + "resource_type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "repository", + "github_file", + "free_text", + "github_issue", + "github_pull_request", + "media_content", + "uploaded_text_file" + ] + }, + "copilot_chat_attachment_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the associated chat attachment, if any." + }, + "metadata": { + "type": "object", + "description": "Resource-specific metadata. The keys and values depend on the resource type.", + "additionalProperties": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the resource was last updated." + } + }, + "required": [ + "id", + "resource_type", + "metadata", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "resource_type": "free_text", + "copilot_chat_attachment_id": null, + "metadata": { + "name": "updated-notes.txt", + "text": "Updated content" + }, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T12:00:00Z" + } + } + } + } + } }, "403": { "description": "Forbidden", @@ -832942,56 +846550,101 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "attestations" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" } - } - }, - "/users/{username}/attestations/{subject_digest}": { - "get": { - "summary": "List attestations", - "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + }, + "delete": { + "summary": "Delete a resource from a Copilot Space for a user", + "description": "Deletes a resource from a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.", "tags": [ - "users" + "copilot-spaces" ], - "operationId": "users/list-attestations", + "operationId": "copilot-spaces/delete-resource-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/resources#delete-a-resource-from-a-copilot-space-for-a-user" }, "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, { "name": "username", "description": "The handle for the GitHub user account.", @@ -833002,226 +846655,54 @@ } }, { - "name": "subject_digest", - "description": "Subject Digest", + "name": "space_number", + "description": "The unique identifier of the Copilot Space.", "in": "path", "required": true, "schema": { - "type": "string" - }, - "x-multi-segment": true + "type": "integer" + } }, { - "name": "predicate_type", - "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", - "in": "query", - "required": false, + "name": "space_resource_id", + "description": "The unique identifier of the resource.", + "in": "path", + "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "attestations": { - "type": "array", - "items": { - "type": "object", - "properties": { - "bundle": { - "type": "object", - "properties": { - "mediaType": { - "type": "string" - }, - "verificationMaterial": { - "type": "object", - "properties": {}, - "additionalProperties": true - }, - "dsseEnvelope": { - "type": "object", - "properties": {}, - "additionalProperties": true - } - }, - "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." - }, - "repository_id": { - "type": "integer" - }, - "bundle_url": { - "type": "string" - }, - "initiator": { - "type": "string" - } - } - } - } - } - }, - "examples": { - "default": { - "value": { - "attestations": [ - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - }, - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - } - ] + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "204": { - "description": "Response" - }, "404": { "description": "Resource not found", "content": { @@ -833250,10 +846731,9 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "attestations" + "enabledForGitHubApps": false, + "category": "copilot-spaces", + "subcategory": "resources" } } }, @@ -833267,7 +846747,7 @@ "operationId": "packages/list-docker-migration-conflicting-packages-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user" }, "parameters": [ { @@ -834638,7 +848118,7 @@ "operationId": "activity/list-events-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-events-for-the-authenticated-user" }, "parameters": [ { @@ -834652,7 +848132,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -834661,7 +848141,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -847647,7 +861127,7 @@ "operationId": "activity/list-org-events-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-organization-events-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-organization-events-for-the-authenticated-user" }, "parameters": [ { @@ -847670,7 +861150,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -847679,7 +861159,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -860684,7 +874164,7 @@ "operationId": "activity/list-public-events-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-events-for-a-user" }, "parameters": [ { @@ -860698,7 +874178,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -860707,7 +874187,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -873693,7 +887173,7 @@ "operationId": "users/list-followers-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/followers#list-followers-of-a-user" }, "parameters": [ { @@ -873707,7 +887187,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -873716,7 +887196,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -873956,7 +887436,7 @@ "operationId": "users/list-following-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/followers#list-the-people-a-user-follows" }, "parameters": [ { @@ -873970,7 +887450,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -873979,7 +887459,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -874219,7 +887699,7 @@ "operationId": "users/check-following-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-user-follows-another-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/followers#check-if-a-user-follows-another-user" }, "parameters": [ { @@ -874266,7 +887746,7 @@ "operationId": "gists/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-gists-for-a-user" }, "parameters": [ { @@ -874290,7 +887770,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -874299,7 +887779,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -874937,7 +888417,7 @@ "operationId": "users/list-gpg-keys-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#list-gpg-keys-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#list-gpg-keys-for-a-user" }, "parameters": [ { @@ -874951,7 +888431,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -874960,7 +888440,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -875255,7 +888735,7 @@ "operationId": "users/get-context-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/users#get-contextual-information-for-a-user" }, "parameters": [ { @@ -875453,14 +888933,14 @@ "/users/{username}/installation": { "get": { "summary": "Get a user installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-user-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-user-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-a-user-installation-for-the-authenticated-app" }, "parameters": [ { @@ -876086,7 +889566,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -876601,7 +890081,7 @@ "operationId": "users/list-public-keys-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/keys#list-public-keys-for-a-user" }, "parameters": [ { @@ -876615,7 +890095,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -876624,7 +890104,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -876701,14 +890181,14 @@ "/users/{username}/orgs": { "get": { "summary": "List organizations for a user", - "description": "List [public organization memberships](https://docs.github.com/enterprise-cloud@latest//articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead.", + "description": "List [public organization memberships](https://docs.github.com/enterprise-cloud@latest/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead.", "tags": [ "orgs" ], "operationId": "orgs/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-organizations-for-a-user" }, "parameters": [ { @@ -876722,7 +890202,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -876731,7 +890211,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -876889,14 +890369,14 @@ "/users/{username}/packages": { "get": { "summary": "List packages for a user", - "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/list-packages-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-packages-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-packages-for-a-user" }, "parameters": [ { @@ -876918,7 +890398,7 @@ }, { "name": "visibility", - "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", + "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", "in": "query", "required": false, "schema": { @@ -876941,7 +890421,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -876950,7 +890430,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -878312,14 +891792,14 @@ "/users/{username}/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for a user", - "description": "Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-for-a-user" }, "parameters": [ { @@ -879686,14 +893166,14 @@ }, "delete": { "summary": "Delete a package for a user", - "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-a-package-for-a-user" }, "parameters": [ { @@ -879826,14 +893306,14 @@ "/users/{username}/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for a user", - "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-a-package-for-a-user" }, "parameters": [ { @@ -879975,14 +893455,14 @@ "/users/{username}/packages/{package_type}/{package_name}/versions": { "get": { "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\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-all-package-versions-for-package-owned-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user" }, "parameters": [ { @@ -880299,14 +893779,14 @@ "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for a user", - "description": "Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-version-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-version-for-a-user" }, "parameters": [ { @@ -880520,14 +894000,14 @@ }, "delete": { "summary": "Delete package version for a user", - "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-version-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-package-version-for-a-user" }, "parameters": [ { @@ -880669,14 +894149,14 @@ "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore package version for a user", - "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-version-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-package-version-for-a-user" }, "parameters": [ { @@ -880825,7 +894305,7 @@ "operationId": "projects/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/projects#list-projects-for-user" }, "parameters": [ { @@ -880848,7 +894328,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -880857,7 +894337,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -880866,7 +894346,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -881932,7 +895412,7 @@ "operationId": "projects/get-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/projects#get-project-for-user" }, "parameters": [ { @@ -883009,7 +896489,7 @@ "operationId": "projects/list-fields-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#list-project-fields-for-user" }, "parameters": [ { @@ -883032,7 +896512,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -883041,7 +896521,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -883050,7 +896530,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -883505,7 +896985,7 @@ "operationId": "projects/add-field-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-field-to-user-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#add-field-to-user-owned-project" }, "parameters": [ { @@ -884241,7 +897721,7 @@ "operationId": "projects/get-field-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#get-project-field-for-user" }, "parameters": [ { @@ -884609,7 +898089,7 @@ "operationId": "projects/list-items-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-a-user-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#list-items-for-a-user-owned-project" }, "parameters": [ { @@ -884632,7 +898112,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -884641,7 +898121,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -884650,7 +898130,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -884659,7 +898139,7 @@ }, { "name": "q", - "description": "Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", + "description": "Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", "in": "query", "required": false, "schema": { @@ -885795,7 +899275,7 @@ "operationId": "projects/add-item-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-user-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#add-item-to-user-owned-project" }, "parameters": [ { @@ -894755,7 +908235,7 @@ "operationId": "projects/get-user-item", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-a-user-owned-project" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#get-an-item-for-a-user-owned-project" }, "parameters": [ { @@ -895911,7 +909391,7 @@ "operationId": "projects/update-item-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#update-project-item-for-user" }, "parameters": [ { @@ -900255,7 +913735,7 @@ "operationId": "projects/delete-item-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#delete-project-item-for-user" }, "parameters": [ { @@ -900361,7 +913841,7 @@ "operationId": "projects/list-view-items-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-a-user-project-view" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/projects/items#list-items-for-a-user-project-view" }, "parameters": [ { @@ -900413,7 +913893,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -900422,7 +913902,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -900431,7 +913911,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -901575,7 +915055,7 @@ "operationId": "activity/list-received-events-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-received-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-events-received-by-the-authenticated-user" }, "parameters": [ { @@ -901589,7 +915069,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -901598,7 +915078,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -914589,7 +928069,7 @@ "operationId": "activity/list-received-public-events-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-received-by-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-events-received-by-a-user" }, "parameters": [ { @@ -914603,7 +928083,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -914612,7 +928092,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -927603,7 +941083,7 @@ "operationId": "repos/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repositories-for-a-user" }, "parameters": [ { @@ -927661,7 +941141,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -927670,7 +941150,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -928786,7 +942266,7 @@ "operationId": "users/list-social-accounts-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#list-social-accounts-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/social-accounts#list-social-accounts-for-a-user" }, "parameters": [ { @@ -928800,7 +942280,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -928809,7 +942289,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -928888,7 +942368,7 @@ "operationId": "users/list-ssh-signing-keys-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user" }, "parameters": [ { @@ -928902,7 +942382,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -928911,7 +942391,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -928994,14 +942474,14 @@ "/users/{username}/starred": { "get": { "summary": "List repositories starred by a user", - "description": "Lists repositories a user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", + "description": "Lists repositories a user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", "tags": [ "activity" ], "operationId": "activity/list-repos-starred-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-repositories-starred-by-a-user" }, "parameters": [ { @@ -929043,7 +942523,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -929052,7 +942532,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -931186,7 +944666,7 @@ "operationId": "activity/list-repos-watched-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#list-repositories-watched-by-a-user" }, "parameters": [ { @@ -931200,7 +944680,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -931209,7 +944689,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -932325,7 +945805,7 @@ "operationId": "meta/get-all-versions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#get-all-api-versions" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/meta/meta#get-all-api-versions" }, "responses": { "200": { @@ -932399,7 +945879,7 @@ "operationId": "meta/get-zen", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#get-the-zen-of-github" + "url": "https://docs.github.com/enterprise-cloud@latest/rest/meta/meta#get-the-zen-of-github" }, "responses": { "200": { @@ -932431,11 +945911,11 @@ "webhooks": { "branch-protection-configuration-disabled": { "post": { - "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "All branch protections were disabled for a repository.", "operationId": "branch-protection-configuration/disabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_configuration" }, "parameters": [ { @@ -932511,7 +945991,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -932601,7 +946081,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -934425,11 +947905,11 @@ }, "branch-protection-configuration-enabled": { "post": { - "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "All branch protections were enabled for a repository.", "operationId": "branch-protection-configuration/enabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_configuration" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_configuration" }, "parameters": [ { @@ -934505,7 +947985,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -934595,7 +948075,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -936419,11 +949899,11 @@ }, "branch-protection-rule-created": { "post": { - "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A branch protection rule was created.", "operationId": "branch-protection-rule/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_rule" }, "parameters": [ { @@ -936499,7 +949979,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -936589,7 +950069,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -938218,7 +951698,7 @@ }, "rule": { "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", "type": "object", "properties": { "admin_enforced": { @@ -938593,11 +952073,11 @@ }, "branch-protection-rule-deleted": { "post": { - "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A branch protection rule was deleted.", "operationId": "branch-protection-rule/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_rule" }, "parameters": [ { @@ -938673,7 +952153,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -938763,7 +952243,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -940392,7 +953872,7 @@ }, "rule": { "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", "type": "object", "properties": { "admin_enforced": { @@ -940767,11 +954247,11 @@ }, "branch-protection-rule-edited": { "post": { - "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A branch protection rule was edited.", "operationId": "branch-protection-rule/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_rule" }, "parameters": [ { @@ -941015,7 +954495,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -941105,7 +954585,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -942734,7 +956214,7 @@ }, "rule": { "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", "type": "object", "properties": { "admin_enforced": { @@ -943109,11 +956589,11 @@ }, "bypass-request-secret-scanning-cancelled": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection 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 secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", "description": "A secret scanning push protection bypass request was cancelled.", "operationId": "exemption-request-secret-scanning/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -943189,7 +956669,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -943279,7 +956759,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -945559,11 +959039,11 @@ }, "bypass-request-secret-scanning-completed": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection 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 secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", "description": "A secret scanning bypass request was completed.", "operationId": "exemption-request-secret-scanning/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -945639,7 +959119,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -945729,7 +959209,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -948009,11 +961489,11 @@ }, "bypass-request-secret-scanning-created": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection 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 secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", "description": "A secret scanning push protection bypass request was created.", "operationId": "exemption-request-secret-scanning/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -948089,7 +961569,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -948179,7 +961659,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -950459,11 +963939,11 @@ }, "bypass-request-secret-scanning-response-dismissed": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection 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 secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", "description": "A secret scanning push protection bypass response was dismissed.", "operationId": "exemption-request-secret-scanning/response-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -950539,7 +964019,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -950629,7 +964109,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -952950,11 +966430,11 @@ }, "bypass-request-secret-scanning-response-submitted": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection 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 secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", "description": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.", "operationId": "exemption-request-secret-scanning/response-submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -953030,7 +966510,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -953120,7 +966600,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -955441,11 +968921,11 @@ }, "check-run-completed": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "description": "A check run was completed, and a conclusion is available.", "operationId": "check-run/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -958246,7 +971726,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -958271,7 +971751,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -960505,11 +973985,11 @@ }, "check-run-created": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "description": "A new check run was created.", "operationId": "check-run/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -963310,7 +976790,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -963335,7 +976815,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -965569,11 +979049,11 @@ }, "check-run-requested-action": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest//developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest/developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", "operationId": "check-run/requested-action", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -968374,7 +981854,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -968399,7 +981879,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -970646,11 +984126,11 @@ }, "check-run-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "description": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", "operationId": "check-run/rerequested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -973451,7 +986931,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -973476,7 +986956,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -975710,11 +989190,11 @@ }, "check-suite-completed": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "description": "All check runs in a check suite have completed, and a conclusion is available.", "operationId": "check-suite/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -975789,7 +989269,7 @@ ] }, "check_suite": { - "description": "The [check_suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite).", + "description": "The [check_suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite).", "type": "object", "properties": { "after": { @@ -976568,7 +990048,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -976658,7 +990138,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -978483,11 +991963,11 @@ }, "check-suite-requested": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest/graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#create-a-check-run)\" in the REST API documentation.", "operationId": "check-suite/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -978562,7 +992042,7 @@ ] }, "check_suite": { - "description": "The [check_suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite).", + "description": "The [check_suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite).", "type": "object", "properties": { "after": { @@ -979374,7 +992854,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -979464,7 +992944,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -981289,11 +994769,11 @@ }, "check-suite-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-cloud@latest/graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", "operationId": "check-suite/rerequested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -981368,7 +994848,7 @@ ] }, "check_suite": { - "description": "The [check_suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite).", + "description": "The [check_suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite).", "type": "object", "properties": { "after": { @@ -982174,7 +995654,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -982264,7 +995744,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -984089,11 +997569,11 @@ }, "code-scanning-alert-appeared-in-branch": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", "description": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", "operationId": "code-scanning-alert/appeared-in-branch", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -984656,7 +998136,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -984746,7 +998226,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -986577,11 +1000057,11 @@ }, "code-scanning-alert-closed-by-user": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", "description": "Someone closed a code scanning alert.", "operationId": "code-scanning-alert/closed-by-user", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -987269,7 +1000749,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -987359,7 +1000839,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -989190,11 +1002670,11 @@ }, "code-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", "description": "A code scanning alert was created in a repository.", "operationId": "code-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -989707,7 +1003187,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -989797,7 +1003277,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -991628,11 +1005108,11 @@ }, "code-scanning-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", "description": "A code scanning alert was fixed in a branch by a commit.", "operationId": "code-scanning-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -992231,7 +1005711,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -992321,7 +1005801,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -994152,11 +1007632,11 @@ }, "code-scanning-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", "description": "A previously fixed code scanning alert reappeared in a branch.", "operationId": "code-scanning-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -994670,7 +1008150,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -994760,7 +1008240,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -996594,11 +1010074,11 @@ }, "code-scanning-alert-reopened-by-user": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", "description": "Someone reopened a code scanning alert.", "operationId": "code-scanning-alert/reopened-by-user", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -997057,7 +1010537,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -997147,7 +1010627,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -998978,11 +1012458,11 @@ }, "code-scanning-alert-updated-assignment": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", "description": "The assignees list of a code scanning alert has been updated.", "operationId": "code-scanning-alert/updated-assignment", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -999541,7 +1013021,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -999631,7 +1013111,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1001456,11 +1014936,11 @@ }, "commit-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-cloud@latest/rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "description": "Someone commented on a commit.", "operationId": "commit-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#commit_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#commit_comment" }, "parameters": [ { @@ -1001773,7 +1015253,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1001863,7 +1015343,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1003691,7 +1017171,7 @@ "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Notes**:\n- This event will not occur when more than three tags are created at once.\n- Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.", "operationId": "create", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#create" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#create" }, "parameters": [ { @@ -1003768,7 +1017248,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1003858,7 +1017338,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1003989,7 +1017469,7 @@ "type": "string" }, "ref": { - "description": "The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource.", + "description": "The [`git ref`](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference) resource.", "type": "string" }, "ref_type": { @@ -1005706,11 +1019186,11 @@ }, "custom-property-created": { "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", "description": "A new custom property was created.", "operationId": "custom-property/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -1005890,7 +1019370,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1005980,7 +1019460,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1006298,11 +1019778,11 @@ }, "custom-property-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", "description": "A custom property was deleted.", "operationId": "custom-property/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -1006390,7 +1019870,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1006480,7 +1019960,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1006798,11 +1020278,11 @@ }, "custom-property-promoted-to-enterprise": { "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", "description": "A custom property was promoted to an enterprise.", "operationId": "custom-property/promote-to-enterprise", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -1006982,7 +1020462,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1007072,7 +1020552,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1007390,11 +1020870,11 @@ }, "custom-property-updated": { "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", "description": "A custom property was updated.", "operationId": "custom-property/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -1007574,7 +1021054,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1007664,7 +1021144,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1007982,11 +1021462,11 @@ }, "custom-property-values-updated": { "post": { - "summary": "This event occurs when there is activity relating to custom property values for a repository.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties for a repository, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "summary": "This event occurs when there is activity relating to custom property values for a repository.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties for a repository, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/repos/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", "description": "The custom property values of a repository were updated.", "operationId": "custom-property-values/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom-property-values" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom-property-values" }, "parameters": [ { @@ -1008062,7 +1021542,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1008152,7 +1021632,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1010057,7 +1023537,7 @@ "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> This event will not occur when more than three tags are deleted at once.", "operationId": "delete", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#delete" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#delete" }, "parameters": [ { @@ -1010127,7 +1023607,7 @@ "properties": { "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1010217,7 +1023697,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1010344,7 +1023824,7 @@ "type": "string" }, "ref": { - "description": "The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource.", + "description": "The [`git ref`](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference) resource.", "type": "string" }, "ref_type": { @@ -1012059,11 +1025539,11 @@ }, "dependabot-alert-assignees-changed": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "The assignees for a Dependabot alert were updated.", "operationId": "dependabot-alert/assignees-changed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -1013138,7 +1026618,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1013262,7 +1026742,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1015053,11 +1028533,11 @@ }, "dependabot-alert-auto-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A Dependabot alert was automatically closed by a Dependabot auto-triage rule.", "operationId": "dependabot-alert/auto-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -1016132,7 +1029612,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1016256,7 +1029736,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1018047,11 +1031527,11 @@ }, "dependabot-alert-auto-reopened": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.", "operationId": "dependabot-alert/auto-reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -1019126,7 +1032606,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1019250,7 +1032730,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1021041,11 +1034521,11 @@ }, "dependabot-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", "operationId": "dependabot-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -1022120,7 +1035600,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1022244,7 +1035724,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1024035,11 +1037515,11 @@ }, "dependabot-alert-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A Dependabot alert was manually closed.", "operationId": "dependabot-alert/dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -1025114,7 +1038594,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1025238,7 +1038718,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1027029,11 +1040509,11 @@ }, "dependabot-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A manifest file change removed a vulnerability.", "operationId": "dependabot-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -1028108,7 +1041588,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1028232,7 +1041712,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1030023,11 +1043503,11 @@ }, "dependabot-alert-reintroduced": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", "operationId": "dependabot-alert/reintroduced", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -1031102,7 +1044582,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1031226,7 +1044706,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1033017,11 +1046497,11 @@ }, "dependabot-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A Dependabot alert was manually reopened.", "operationId": "dependabot-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -1034096,7 +1047576,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1034220,7 +1047700,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1036011,11 +1049491,11 @@ }, "deploy-key-created": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", "description": "A deploy key was created.", "operationId": "deploy-key/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { @@ -1036091,7 +1049571,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1036181,7 +1049661,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1036205,7 +1049685,7 @@ ] }, "key": { - "description": "The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource.", + "description": "The [`deploy key`](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource.", "type": "object", "properties": { "added_by": { @@ -1038058,11 +1051538,11 @@ }, "deploy-key-deleted": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", "description": "A deploy key was deleted.", "operationId": "deploy-key/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { @@ -1038138,7 +1051618,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1038228,7 +1051708,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1038252,7 +1051732,7 @@ ] }, "key": { - "description": "The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource.", + "description": "The [`deploy key`](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource.", "type": "object", "properties": { "added_by": { @@ -1040105,11 +1053585,11 @@ }, "deployment-created": { "post": { - "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", "description": "A deployment was created.", "operationId": "deployment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment" }, "parameters": [ { @@ -1040185,7 +1053665,7 @@ }, "deployment": { "title": "Deployment", - "description": "The [deployment](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments).", + "description": "The [deployment](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#list-deployments).", "type": "object", "properties": { "created_at": { @@ -1040841,7 +1054321,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1040931,7 +1054411,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1043688,11 +1057168,11 @@ }, "deployment-protection-rule-requested": { "post": { - "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", "description": "A deployment protection rule was requested for an environment.", "operationId": "deployment-protection-rule/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_protection_rule" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_protection_rule" }, "parameters": [ { @@ -1050439,7 +1063919,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1050652,11 +1064132,11 @@ }, "deployment-review-approved": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", "description": "A deployment review was approved.", "operationId": "deployment-review/approved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -1050796,7 +1064276,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1050886,7 +1064366,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1053789,11 +1067269,11 @@ }, "deployment-review-rejected": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", "description": "A deployment review was rejected.", "operationId": "deployment-review/rejected", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -1053933,7 +1067413,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1054023,7 +1067503,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1056926,11 +1070406,11 @@ }, "deployment-review-requested": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", "description": "A deployment review was requested.", "operationId": "deployment-review/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -1057005,7 +1070485,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1057098,7 +1070578,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1060072,11 +1073552,11 @@ }, "deployment-status-created": { "post": { - "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n> [!NOTE]\n> A webhook event is not fired for deployment statuses with an `inactive` state.", + "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n> [!NOTE]\n> A webhook event is not fired for deployment statuses with an `inactive` state.", "description": "A new deployment status was created.", "operationId": "deployment-status/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_status" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_status" }, "parameters": [ { @@ -1060244,7 +1073724,7 @@ }, "deployment": { "title": "Deployment", - "description": "The [deployment](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments).", + "description": "The [deployment](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#list-deployments).", "type": "object", "properties": { "created_at": { @@ -1060904,7 +1074384,7 @@ ] }, "deployment_status": { - "description": "The [deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses).", + "description": "The [deployment status](https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#list-deployment-statuses).", "type": "object", "properties": { "created_at": { @@ -1061543,7 +1075023,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1061633,7 +1075113,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1064391,11 +1077871,11 @@ }, "discussion-answered": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on the discussion was marked as the answer.", "operationId": "discussion/answered", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -1065182,7 +1078662,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1065272,7 +1078752,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1067098,11 +1080578,11 @@ }, "discussion-category-changed": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "The category of a discussion was changed.", "operationId": "discussion/category-changed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -1067735,7 +1081215,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1067825,7 +1081305,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1069651,11 +1083131,11 @@ }, "discussion-closed": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was closed.", "operationId": "discussion/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -1070225,7 +1083705,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1070315,7 +1083795,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1072140,11 +1085620,11 @@ }, "discussion-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on a discussion was created.", "operationId": "discussion-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -1072931,7 +1086411,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1073021,7 +1086501,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1074847,11 +1088327,11 @@ }, "discussion-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on a discussion was deleted.", "operationId": "discussion-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -1075638,7 +1089118,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1075728,7 +1089208,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1077554,11 +1091034,11 @@ }, "discussion-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on a discussion was edited.", "operationId": "discussion-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -1078364,7 +1091844,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1078454,7 +1091934,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1080281,11 +1093761,11 @@ }, "discussion-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was created.", "operationId": "discussion/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -1080855,7 +1094335,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1080945,7 +1094425,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1082770,11 +1096250,11 @@ }, "discussion-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was deleted.", "operationId": "discussion/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -1083344,7 +1096824,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1083434,7 +1096914,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1085259,11 +1098739,11 @@ }, "discussion-edited": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", "operationId": "discussion/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -1085860,7 +1099340,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1085950,7 +1099430,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1087775,11 +1101255,11 @@ }, "discussion-labeled": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A label was added to a discussion.", "operationId": "discussion/labeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -1088349,7 +1101829,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1088439,7 +1101919,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1090308,11 +1103788,11 @@ }, "discussion-locked": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was locked.", "operationId": "discussion/locked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -1090882,7 +1104362,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1090972,7 +1104452,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1092797,11 +1106277,11 @@ }, "discussion-pinned": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was pinned.", "operationId": "discussion/pinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -1093371,7 +1106851,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1093461,7 +1106941,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1095286,11 +1108766,11 @@ }, "discussion-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was reopened.", "operationId": "discussion/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -1095860,7 +1109340,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1095950,7 +1109430,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1097775,11 +1111255,11 @@ }, "discussion-transferred": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was transferred to another repository.", "operationId": "discussion/transferred", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -1100357,7 +1113837,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1100447,7 +1113927,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1102273,11 +1115753,11 @@ }, "discussion-unanswered": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on the discussion was unmarked as the answer.", "operationId": "discussion/unanswered", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -1104864,11 +1118344,11 @@ }, "discussion-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A label was removed from a discussion.", "operationId": "discussion/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -1105438,7 +1118918,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1105528,7 +1119008,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1107397,11 +1120877,11 @@ }, "discussion-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was unlocked.", "operationId": "discussion/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -1107971,7 +1121451,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1108061,7 +1121541,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1109886,11 +1123366,11 @@ }, "discussion-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was unpinned.", "operationId": "discussion/unpinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -1110460,7 +1123940,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1110550,7 +1124030,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1112379,7 +1125859,7 @@ "description": "A code scanning alert dismissal request was created.", "operationId": "dismissal-request-code-scanning/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" }, "parameters": [ { @@ -1112455,7 +1125935,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1112545,7 +1126025,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1114829,7 +1128309,7 @@ "description": "A code scanning alert dismissal response was submitted.", "operationId": "dismissal-request-code-scanning/response-submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" }, "parameters": [ { @@ -1114905,7 +1128385,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1114995,7 +1128475,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1117320,7 +1130800,7 @@ "description": "A Dependabot alert dismissal request was canceled.", "operationId": "dismissal-request-dependabot/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_dependabot" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_dependabot" }, "parameters": [ { @@ -1117396,7 +1130876,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1117486,7 +1130966,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1119770,7 +1133250,7 @@ "description": "A Dependabot alert dismissal request was created.", "operationId": "dismissal-request-dependabot/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_dependabot" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_dependabot" }, "parameters": [ { @@ -1119846,7 +1133326,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1119936,7 +1133416,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1122220,7 +1135700,7 @@ "description": "A Dependabot alert dismissal request received a response.", "operationId": "dismissal-request-dependabot/response-submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_dependabot" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_dependabot" }, "parameters": [ { @@ -1122296,7 +1135776,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1122386,7 +1135866,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1124711,7 +1138191,7 @@ "description": "A secret scanning alert dismissal request was canceled.", "operationId": "dismissal-request-secret-scanning/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -1124787,7 +1138267,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1124877,7 +1138357,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1127161,7 +1140641,7 @@ "description": "A secret scanning alert dismissal request was completed.", "operationId": "dismissal-request-secret-scanning/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -1127237,7 +1140717,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1127327,7 +1140807,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1129611,7 +1143091,7 @@ "description": "A secret scanning alert dismissal request was created.", "operationId": "dismissal-request-secret-scanning/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -1129687,7 +1143167,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1129777,7 +1143257,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1132061,7 +1145541,7 @@ "description": "A secret scanning alert dismissal response was dismissed.", "operationId": "dismissal-request-secret-scanning/response-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -1132137,7 +1145617,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1132227,7 +1145707,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1134552,7 +1148032,7 @@ "description": "A secret scanning alert dismissal response was submitted.", "operationId": "dismissal-request-secret-scanning/response-submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -1134628,7 +1148108,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1134718,7 +1148198,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1137039,11 +1150519,11 @@ }, "exemption-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.", + "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": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" }, "parameters": [ { @@ -1137119,7 +1150599,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1137209,7 +1150689,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1139489,11 +1152969,11 @@ }, "exemption-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.", + "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": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" }, "parameters": [ { @@ -1139569,7 +1153049,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1139659,7 +1153139,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1141939,11 +1155419,11 @@ }, "exemption-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.", + "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": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" }, "parameters": [ { @@ -1142019,7 +1155499,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1142109,7 +1155589,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1144389,11 +1157869,11 @@ }, "exemption-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.", + "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": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" }, "parameters": [ { @@ -1144469,7 +1157949,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1144559,7 +1158039,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1146880,11 +1160360,11 @@ }, "exemption-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.", + "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": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" }, "parameters": [ { @@ -1146960,7 +1160440,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1147050,7 +1160530,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1149371,10 +1162851,10 @@ }, "fork": { "post": { - "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-cloud@latest/get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-cloud@latest/rest/repos/forks)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "fork", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#fork" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#fork" }, "parameters": [ { @@ -1149445,7 +1162925,7 @@ "properties": { "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1149534,7 +1163014,7 @@ ] }, "forkee": { - "description": "The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource.", + "description": "The created [`repository`](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) resource.", "allOf": [ { "title": "Repository", @@ -1150474,7 +1163954,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1152299,11 +1165779,11 @@ }, "github-app-authorization-revoked": { "post": { - "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", + "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", "description": "Someone revoked their authorization of a GitHub App.", "operationId": "github-app-authorization/revoked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#github_app_authorization" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#github_app_authorization" }, "parameters": [ { @@ -1152571,10 +1166051,10 @@ }, "gollum": { "post": { - "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-cloud@latest/communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "gollum", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#gollum" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#gollum" }, "parameters": [ { @@ -1152644,7 +1166124,7 @@ "properties": { "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1152734,7 +1166214,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1154606,11 +1168086,11 @@ }, "installation-created": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)\" in the REST API documentation.", "description": "Someone installed a GitHub App on a user or organization account.", "operationId": "installation/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -1154686,7 +1168166,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1155382,7 +1168862,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1157753,11 +1171233,11 @@ }, "installation-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)\" in the REST API documentation.", "description": "Someone uninstalled a GitHub App from their user or organization account.", "operationId": "installation/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -1157833,7 +1171313,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1158529,7 +1172009,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1160805,11 +1174285,11 @@ }, "installation-new-permissions-accepted": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)\" in the REST API documentation.", "description": "Someone granted new permissions to a GitHub App.", "operationId": "installation/new-permissions-accepted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -1160885,7 +1174365,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1161581,7 +1175061,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1163857,11 +1177337,11 @@ }, "installation-repositories-added": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)\" in the REST API documentation.", "description": "A GitHub App installation was granted access to one or more repositories.", "operationId": "installation-repositories/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { @@ -1163937,7 +1177417,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1164633,7 +1178113,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1167043,11 +1180523,11 @@ }, "installation-repositories-removed": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)\" in the REST API documentation.", "description": "Access to one or more repositories was revoked for a GitHub App installation.", "operationId": "installation-repositories/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { @@ -1167123,7 +1180603,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1167819,7 +1181299,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1170236,11 +1183716,11 @@ }, "installation-suspend": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)\" in the REST API documentation.", "description": "Someone blocked access by a GitHub App to their user or organization account.", "operationId": "installation/suspend", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -1170316,7 +1183796,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1171012,7 +1184492,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1173288,11 +1186768,11 @@ }, "installation-target-renamed": { "post": { - "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)\" in the REST API documentation.", "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", "operationId": "installation-target/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_target" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation_target" }, "parameters": [ { @@ -1173523,7 +1187003,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1173613,7 +1187093,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1175440,11 +1188920,11 @@ }, "installation-unsuspend": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)\" in the REST API documentation.", "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", "operationId": "installation/unsuspend", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -1175520,7 +1189000,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1176216,7 +1189696,7 @@ }, "organization_copilot_agent_settings": { "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": [ "read", "write" @@ -1178492,11 +1191972,11 @@ }, "issue-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A comment on an issue or pull request was created.", "operationId": "issue-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -1178572,7 +1192052,7 @@ }, "comment": { "title": "issue comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself.", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment) itself.", "type": "object", "properties": { "author_association": { @@ -1179398,7 +1192878,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1179488,7 +1192968,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1179512,11 +1192992,11 @@ ] }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1183017,11 +1196497,11 @@ }, "issue-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A comment on an issue or pull request was deleted.", "operationId": "issue-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -1183097,7 +1196577,7 @@ }, "comment": { "title": "issue comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself.", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment) itself.", "type": "object", "properties": { "author_association": { @@ -1183917,7 +1197397,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1184007,7 +1197487,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1184031,11 +1197511,11 @@ ] }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1187535,11 +1201015,11 @@ }, "issue-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A comment on an issue or pull request was edited.", "operationId": "issue-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -1187633,7 +1201113,7 @@ }, "comment": { "title": "issue comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself.", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment) itself.", "type": "object", "properties": { "author_association": { @@ -1188453,7 +1201933,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1188543,7 +1202023,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1188567,11 +1202047,11 @@ ] }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1192072,11 +1205552,11 @@ }, "issue-comment-pinned": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A comment on an issue was pinned.", "operationId": "issue-comment/pinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -1192152,7 +1205632,7 @@ }, "comment": { "title": "issue comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself.", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment) itself.", "type": "object", "properties": { "author_association": { @@ -1192972,7 +1206452,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1193062,7 +1206542,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1193086,11 +1206566,11 @@ ] }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1196597,11 +1210077,11 @@ }, "issue-comment-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A comment on an issue was unpinned.", "operationId": "issue-comment/unpinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -1196677,7 +1210157,7 @@ }, "comment": { "title": "issue comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself.", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment) itself.", "type": "object", "properties": { "author_association": { @@ -1197497,7 +1210977,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1197587,7 +1211067,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1197611,11 +1211091,11 @@ ] }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1201126,7 +1214606,7 @@ "description": "An issue was marked as blocked by another issue.", "operationId": "issue-dependencies/blocked-by-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { @@ -1209900,7 +1223380,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1211729,7 +1225209,7 @@ "description": "The blocked by relationship between an issue and another issue was removed.", "operationId": "issue-dependencies/blocked-by-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { @@ -1220503,7 +1233983,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1222332,7 +1235812,7 @@ "description": "An issue was marked as blocking another issue.", "operationId": "issue-dependencies/blocking-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { @@ -1231106,7 +1244586,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1232935,7 +1246415,7 @@ "description": "The blocking relationship between an issue and another issue was removed.", "operationId": "issue-dependencies/blocking-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { @@ -1241709,7 +1255189,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1243534,11 +1257014,11 @@ }, "issues-assigned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue was assigned to a user.", "operationId": "issues/assigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1243715,7 +1257195,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1243805,7 +1257285,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1243830,7 +1257310,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1248016,11 +1261496,11 @@ }, "issues-closed": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue was closed.", "operationId": "issues/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1248097,7 +1261577,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1248187,7 +1261667,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1248211,11 +1261691,11 @@ ] }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1252620,11 +1266100,11 @@ }, "issues-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue was deleted.", "operationId": "issues/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1252700,7 +1266180,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1252790,7 +1266270,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1252815,7 +1266295,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1256995,11 +1270475,11 @@ }, "issues-demilestoned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue was removed from a milestone.", "operationId": "issues/demilestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1257075,7 +1270555,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1257165,7 +1270645,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1257190,7 +1270670,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -1261564,11 +1275044,11 @@ }, "issues-edited": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "The title or body on an issue was edited.", "operationId": "issues/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1261674,7 +1275154,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1261764,7 +1275244,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1261789,7 +1275269,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1266017,11 +1279497,11 @@ }, "issues-field-added": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue field value was set or updated on an issue.", "operationId": "issues/field-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1266097,7 +1279577,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1266187,7 +1279667,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1266212,7 +1279692,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1270559,11 +1284039,11 @@ }, "issues-field-removed": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue field value was cleared from an issue.", "operationId": "issues/field-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1270639,7 +1284119,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1270729,7 +1284209,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1270754,7 +1284234,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1275028,11 +1288508,11 @@ }, "issues-labeled": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A label was added to an issue.", "operationId": "issues/labeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1275108,7 +1288588,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1275198,7 +1288678,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1275223,7 +1288703,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1279449,11 +1292929,11 @@ }, "issues-locked": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "issues/locked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1279529,7 +1293009,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1279619,7 +1293099,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1279644,7 +1293124,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -1283832,11 +1297312,11 @@ }, "issues-milestoned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue was added to a milestone.", "operationId": "issues/milestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1283912,7 +1297392,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1284002,7 +1297482,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1284027,7 +1297507,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -1288400,11 +1301880,11 @@ }, "issues-opened": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", "operationId": "issues/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1288483,7 +1301963,7 @@ "properties": { "old_issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": [ "object", "null" @@ -1291492,7 +1304972,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1291582,7 +1305062,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1291607,7 +1305087,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1295791,11 +1309271,11 @@ }, "issues-pinned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", "operationId": "issues/pinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1295871,7 +1309351,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1295961,7 +1309441,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1295986,7 +1309466,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1300165,11 +1313645,11 @@ }, "issues-reopened": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A closed issue was reopened.", "operationId": "issues/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1300245,7 +1313725,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1300335,7 +1313815,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1300360,7 +1313840,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -1304544,11 +1318024,11 @@ }, "issues-transferred": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", "operationId": "issues/transferred", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1304627,7 +1318107,7 @@ "properties": { "new_issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1307654,7 +1321134,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1307744,7 +1321224,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1307769,7 +1321249,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1311949,11 +1325429,11 @@ }, "issues-typed": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue type was added to an issue.", "operationId": "issues/typed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1312029,7 +1325509,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1312119,7 +1325599,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1312144,7 +1325624,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1316398,11 +1329878,11 @@ }, "issues-unassigned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A user was unassigned from an issue.", "operationId": "issues/unassigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1316579,7 +1330059,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1316669,7 +1330149,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1316694,7 +1330174,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1320880,11 +1334360,11 @@ }, "issues-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A label was removed from an issue.", "operationId": "issues/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1320960,7 +1334440,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1321050,7 +1334530,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1321075,7 +1334555,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1325304,11 +1338784,11 @@ }, "issues-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "issues/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1325384,7 +1338864,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1325474,7 +1338954,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1325499,7 +1338979,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -1329685,11 +1343165,11 @@ }, "issues-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", "operationId": "issues/unpinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1329765,7 +1343245,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1329855,7 +1343335,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1329880,7 +1343360,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1334059,11 +1347539,11 @@ }, "issues-untyped": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue type was removed from an issue.", "operationId": "issues/untyped", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -1334139,7 +1347619,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1334229,7 +1347709,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1334254,7 +1347734,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -1338508,11 +1351988,11 @@ }, "label-created": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "A label was created.", "operationId": "label/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -1338588,7 +1352068,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1338678,7 +1352158,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1340545,11 +1354025,11 @@ }, "label-deleted": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "A label was deleted.", "operationId": "label/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -1340625,7 +1354105,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1340715,7 +1354195,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1342583,11 +1356063,11 @@ }, "label-edited": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "A label's name, description, or color was changed.", "operationId": "label/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -1342705,7 +1356185,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1342795,7 +1356275,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1344663,11 +1358143,11 @@ }, "marketplace-purchase-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)\" in the REST API documentation.", "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", "operationId": "marketplace-purchase/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -1344746,7 +1358226,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1344836,7 +1358316,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1346900,11 +1360380,11 @@ }, "marketplace-purchase-changed": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)\" in the REST API documentation.", "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", "operationId": "marketplace-purchase/changed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -1346983,7 +1360463,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1347073,7 +1360553,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1349141,11 +1362621,11 @@ }, "marketplace-purchase-pending-change": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)\" in the REST API documentation.", "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", "operationId": "marketplace-purchase/pending-change", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -1349224,7 +1362704,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1349314,7 +1362794,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1351379,11 +1364859,11 @@ }, "marketplace-purchase-pending-change-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)\" in the REST API documentation.", "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", "operationId": "marketplace-purchase/pending-change-cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -1351462,7 +1364942,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1351552,7 +1365032,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1353612,11 +1367092,11 @@ }, "marketplace-purchase-purchased": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)\" in the REST API documentation.", "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", "operationId": "marketplace-purchase/purchased", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -1353695,7 +1367175,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1353785,7 +1367265,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1355849,11 +1369329,11 @@ }, "member-added": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A GitHub user accepted an invitation to a repository.", "operationId": "member/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -1355963,7 +1369443,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1356053,7 +1369533,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1357979,11 +1371459,11 @@ }, "member-edited": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "Permissions were changed for a collaborator on a repository.", "operationId": "member/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -1358094,7 +1371574,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1358184,7 +1371664,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1360111,11 +1373591,11 @@ }, "member-removed": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A collaborator was removed from a repository.", "operationId": "member/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -1360191,7 +1373671,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1360281,7 +1373761,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1362207,11 +1375687,11 @@ }, "membership-added": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "An organization member was added to a team.", "operationId": "membership/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -1362287,7 +1375767,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1362377,7 +1375857,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1364438,11 +1377918,11 @@ }, "membership-removed": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "An organization member was removed from a team.", "operationId": "membership/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -1364518,7 +1377998,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1364608,7 +1378088,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1366670,14 +1380150,14 @@ }, "merge-group-checks-requested": { "post": { - "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", "operationId": "merge-group/checks-requested", "tags": [ "merge-queue" ], "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#merge_group" }, "parameters": [ { @@ -1366752,7 +1380232,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1368700,14 +1382180,14 @@ }, "merge-group-destroyed": { "post": { - "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.", "operationId": "merge-group/destroyed", "tags": [ "merge-queue" ], "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#merge_group" }, "parameters": [ { @@ -1368791,7 +1382271,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1370743,7 +1384223,7 @@ "description": "The webhook was deleted.", "operationId": "meta/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#meta" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#meta" }, "parameters": [ { @@ -1370819,7 +1384299,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1371036,7 +1384516,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1372869,11 +1386349,11 @@ }, "milestone-closed": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", "description": "A milestone was closed.", "operationId": "milestone/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -1372949,7 +1386429,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1373039,7 +1386519,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1375057,11 +1388537,11 @@ }, "milestone-created": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", "description": "A milestone was created.", "operationId": "milestone/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -1375137,7 +1388617,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1375227,7 +1388707,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1377244,11 +1390724,11 @@ }, "milestone-deleted": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", "description": "A milestone was deleted.", "operationId": "milestone/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -1377324,7 +1390804,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1377414,7 +1390894,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1379432,11 +1392912,11 @@ }, "milestone-edited": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", "description": "A milestone was edited.", "operationId": "milestone/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -1379554,7 +1393034,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1379644,7 +1393124,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1381663,11 +1395143,11 @@ }, "milestone-opened": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", "description": "A milestone was opened.", "operationId": "milestone/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -1381743,7 +1395223,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1381833,7 +1395313,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1383850,11 +1397330,11 @@ }, "org-block-blocked": { "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", "description": "A user was blocked from the organization.", "operationId": "org-block/blocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#org_block" }, "parameters": [ { @@ -1384030,7 +1397510,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1384120,7 +1397600,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1385945,11 +1399425,11 @@ }, "org-block-unblocked": { "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", "description": "A previously blocked user was unblocked from the organization.", "operationId": "org-block/unblocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#org_block" }, "parameters": [ { @@ -1386125,7 +1399605,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1386215,7 +1399695,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1388044,7 +1401524,7 @@ "description": "A new organization custom property was created.", "operationId": "organization-custom-property/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { @@ -1388229,7 +1401709,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1388516,7 +1401996,7 @@ "description": "An organization custom property was deleted.", "operationId": "organization-custom-property/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { @@ -1388604,7 +1402084,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1388694,7 +1402174,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1388916,7 +1402396,7 @@ "description": "An organization custom property was updated.", "operationId": "organization-custom-property/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { @@ -1389101,7 +1402581,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1389191,7 +1402671,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1389413,7 +1402893,7 @@ "description": "The custom property values of an organization were updated.", "operationId": "organization-custom-property-values/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization-custom-property-values" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization-custom-property-values" }, "parameters": [ { @@ -1389489,7 +1402969,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1389579,7 +1403059,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1389976,11 +1403456,11 @@ }, "organization-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "An organization was deleted.", "operationId": "organization/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -1390056,7 +1403536,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1390146,7 +1403626,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1392117,11 +1405597,11 @@ }, "organization-member-added": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A member accepted an invitation to join an organization.", "operationId": "organization/member-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -1392197,7 +1405677,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1392287,7 +1405767,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1394259,11 +1407739,11 @@ }, "organization-member-invited": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A member was invited to join the organization.", "operationId": "organization/member-invited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -1394339,7 +1407819,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1394429,7 +1407909,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1396520,11 +1410000,11 @@ }, "organization-member-removed": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A member was removed from the organization.", "operationId": "organization/member-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -1396600,7 +1410080,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1396690,7 +1410170,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1398662,11 +1412142,11 @@ }, "organization-renamed": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "The name of an organization was changed.", "operationId": "organization/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -1398755,7 +1412235,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1398845,7 +1412325,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1400816,11 +1414296,11 @@ }, "package-published": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)\" in the REST API documentation.", "description": "A package was published to a registry.", "operationId": "package/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -1400896,7 +1414376,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1400986,7 +1414466,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1403710,11 +1417190,11 @@ }, "package-updated": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)\" in the REST API documentation.", "description": "A previously published package was updated.", "operationId": "package/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -1403790,7 +1417270,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1403880,7 +1417360,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1406351,10 +1419831,10 @@ }, "page-build": { "post": { - "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-cloud@latest//pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/enterprise-cloud@latest//rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", + "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-cloud@latest/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/enterprise-cloud@latest/rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", "operationId": "page-build", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#page_build" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#page_build" }, "parameters": [ { @@ -1406423,7 +1419903,7 @@ "type": "object", "properties": { "build": { - "description": "The [List GitHub Pages builds](https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-github-pages-builds) itself.", + "description": "The [List GitHub Pages builds](https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#list-github-pages-builds) itself.", "type": "object", "properties": { "commit": { @@ -1406575,7 +1420055,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1406668,7 +1420148,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1408493,11 +1421973,11 @@ }, "personal-access-token-request-approved": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", "description": "A fine-grained personal access token request was approved.", "operationId": "personal-access-token-request/approved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -1408923,7 +1422403,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1409280,7 +1422760,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1409333,11 +1422813,11 @@ }, "personal-access-token-request-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", "description": "A fine-grained personal access token request was cancelled by the requester.", "operationId": "personal-access-token-request/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -1409763,7 +1423243,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1410120,7 +1423600,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1410173,11 +1423653,11 @@ }, "personal-access-token-request-created": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", "description": "A fine-grained personal access token request was created.", "operationId": "personal-access-token-request/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -1410603,7 +1424083,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1410960,7 +1424440,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1411012,11 +1424492,11 @@ }, "personal-access-token-request-denied": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", "description": "A fine-grained personal access token request was denied.", "operationId": "personal-access-token-request/denied", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -1411541,7 +1425021,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1411799,7 +1425279,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1411855,7 +1425335,7 @@ "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", "operationId": "ping", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#ping" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#ping" }, "parameters": [ { @@ -1411961,7 +1425441,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -1414037,11 +1427517,11 @@ }, "project-card-converted": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A note in a project (classic) was converted to an issue.", "operationId": "project-card/converted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -1414136,7 +1427616,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1414226,7 +1427706,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1416219,11 +1429699,11 @@ }, "project-card-created": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A card was added to a project (classic).", "operationId": "project-card/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -1416299,7 +1429779,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1416389,7 +1429869,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1418381,11 +1431861,11 @@ }, "project-card-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A card on a project (classic) was deleted.", "operationId": "project-card/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -1418461,7 +1431941,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1418551,7 +1432031,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1420554,11 +1434034,11 @@ }, "project-card-edited": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A note on a project (classic) was edited.", "operationId": "project-card/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -1420656,7 +1434136,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1420746,7 +1434226,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1422739,11 +1436219,11 @@ }, "project-card-moved": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A card on a project (classic) was moved to another column or to another position in its column.", "operationId": "project-card/moved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -1422838,7 +1436318,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1422928,7 +1436408,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1425034,11 +1438514,11 @@ }, "project-closed": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A project (classic) was closed.", "operationId": "project/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -1425114,7 +1438594,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1425204,7 +1438684,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1427200,11 +1440680,11 @@ }, "project-column-created": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A column was added to a project (classic).", "operationId": "project-column/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -1427280,7 +1440760,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1427370,7 +1440850,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1429246,11 +1442726,11 @@ }, "project-column-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A column was deleted from a project (classic).", "operationId": "project-column/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -1429326,7 +1442806,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1429416,7 +1442896,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1431299,11 +1444779,11 @@ }, "project-column-edited": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "The name of a column on a project (classic) was changed.", "operationId": "project-column/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -1431395,7 +1444875,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1431485,7 +1444965,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1433362,11 +1446842,11 @@ }, "project-column-moved": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A column was moved to a new position on a project (classic).", "operationId": "project-column/moved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -1433442,7 +1446922,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1433532,7 +1447012,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1435409,11 +1448889,11 @@ }, "project-created": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A project (classic) was created.", "operationId": "project/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -1435489,7 +1448969,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1435579,7 +1449059,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1437575,11 +1451055,11 @@ }, "project-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A project (classic) was deleted.", "operationId": "project/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -1437655,7 +1451135,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1437745,7 +1451225,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1439747,11 +1453227,11 @@ }, "project-edited": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "The name or description of a project (classic) was changed.", "operationId": "project/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -1439857,7 +1453337,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1439947,7 +1453427,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1441942,11 +1455422,11 @@ }, "project-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A project (classic) was closed.", "operationId": "project/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -1442022,7 +1455502,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1442112,7 +1455592,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1444108,11 +1457588,11 @@ }, "projects-v2-closed": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A project in the organization was closed.", "operationId": "projects-v2/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -1444188,7 +1457668,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1445382,11 +1458862,11 @@ }, "projects-v2-created": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A project in the organization was created.", "operationId": "projects-v2/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -1445462,7 +1458942,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1446656,11 +1460136,11 @@ }, "projects-v2-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A project in the organization was deleted.", "operationId": "projects-v2/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -1446736,7 +1460216,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1447930,11 +1461410,11 @@ }, "projects-v2-edited": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "The title, description, or README of a project in the organization was changed.", "operationId": "projects-v2/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -1448071,7 +1461551,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1449266,11 +1462746,11 @@ }, "projects-v2-item-archived": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", "operationId": "projects-v2-item/archived", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -1449370,7 +1462850,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1449926,11 +1463406,11 @@ }, "projects-v2-item-converted": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A draft issue in an organization project was converted to an issue.", "operationId": "projects-v2-item/converted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -1450025,7 +1463505,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1450581,11 +1464061,11 @@ }, "projects-v2-item-created": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "An item was added to a project in the organization.", "operationId": "projects-v2-item/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -1450661,7 +1464141,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1451216,11 +1464696,11 @@ }, "projects-v2-item-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "An item was deleted from a project in the organization.", "operationId": "projects-v2-item/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -1451296,7 +1464776,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1451851,11 +1465331,11 @@ }, "projects-v2-item-edited": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", "operationId": "projects-v2-item/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -1452166,7 +1465646,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1452721,11 +1466201,11 @@ }, "projects-v2-item-reordered": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", "operationId": "projects-v2-item/reordered", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -1452823,7 +1466303,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1453379,11 +1466859,11 @@ }, "projects-v2-item-restored": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", "operationId": "projects-v2-item/restored", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -1453483,7 +1466963,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1454039,11 +1467519,11 @@ }, "projects-v2-reopened": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A project in the organization was reopened.", "operationId": "projects-v2/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -1454119,7 +1467599,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1455313,11 +1468793,11 @@ }, "projects-v2-status-update-created": { "post": { - "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A status update was added to a project in the organization.", "operationId": "projects-v2-status-update/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -1455393,7 +1468873,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1455962,11 +1469442,11 @@ }, "projects-v2-status-update-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A status update was removed from a project in the organization.", "operationId": "projects-v2-status-update/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -1456042,7 +1469522,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1456611,11 +1470091,11 @@ }, "projects-v2-status-update-edited": { "post": { - "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A status update was edited on a project in the organization.", "operationId": "projects-v2-status-update/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -1456784,7 +1470264,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1457353,10 +1470833,10 @@ }, "public": { "post": { - "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "operationId": "public", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#public" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#public" }, "parameters": [ { @@ -1457426,7 +1470906,7 @@ "properties": { "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1457516,7 +1470996,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1459339,11 +1472819,11 @@ }, "pull-request-assigned": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request was assigned to a user.", "operationId": "pull-request/assigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1459519,7 +1472999,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1459609,7 +1473089,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1464549,11 +1478029,11 @@ }, "pull-request-auto-merge-disabled": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", "operationId": "pull-request/auto-merge-disabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1464629,7 +1478109,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1464719,7 +1478199,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1469649,11 +1483129,11 @@ }, "pull-request-auto-merge-enabled": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", "operationId": "pull-request/auto-merge-enabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1469729,7 +1483209,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1469819,7 +1483299,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1474748,11 +1488228,11 @@ }, "pull-request-closed": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", "operationId": "pull-request/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1474828,7 +1488308,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1474918,7 +1488398,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1481124,11 +1494604,11 @@ }, "pull-request-converted-to-draft": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", "operationId": "pull-request/converted-to-draft", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1481204,7 +1494684,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1481294,7 +1494774,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1487500,11 +1500980,11 @@ }, "pull-request-demilestoned": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request was removed from a milestone.", "operationId": "pull-request/demilestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1487580,7 +1501060,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1492876,11 +1506356,11 @@ }, "pull-request-dequeued": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request was removed from the merge queue.", "operationId": "pull-request/dequeued", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1492956,7 +1506436,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1493046,7 +1506526,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1497981,11 +1511461,11 @@ }, "pull-request-edited": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.", "operationId": "pull-request/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1498122,7 +1511602,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1498212,7 +1511692,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1504418,11 +1517898,11 @@ }, "pull-request-enqueued": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request was added to the merge queue.", "operationId": "pull-request/enqueued", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1504498,7 +1517978,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1504588,7 +1518068,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1509505,11 +1522985,11 @@ }, "pull-request-labeled": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A label was added to a pull request.", "operationId": "pull-request/labeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1509585,7 +1523065,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1509675,7 +1523155,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1514655,11 +1528135,11 @@ }, "pull-request-locked": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "pull-request/locked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1514735,7 +1528215,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1514825,7 +1528305,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1519760,11 +1533240,11 @@ }, "pull-request-milestoned": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request was added to a milestone.", "operationId": "pull-request/milestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1519840,7 +1533320,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1525136,11 +1538616,11 @@ }, "pull-request-opened": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request was created", "operationId": "pull-request/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1525216,7 +1538696,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1525306,7 +1538786,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1531512,11 +1544992,11 @@ }, "pull-request-ready-for-review": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", "operationId": "pull-request/ready-for-review", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1531592,7 +1545072,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1531682,7 +1545162,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1537888,11 +1551368,11 @@ }, "pull-request-reopened": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A previously closed pull request was reopened.", "operationId": "pull-request/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1537968,7 +1551448,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1538058,7 +1551538,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1544264,11 +1557744,11 @@ }, "pull-request-review-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A comment on a pull request diff was created.", "operationId": "pull-request-review-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -1544344,7 +1557824,7 @@ }, "comment": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -1544721,7 +1558201,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1544811,7 +1558291,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1549586,11 +1563066,11 @@ }, "pull-request-review-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A comment on a pull request diff was deleted.", "operationId": "pull-request-review-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -1549666,7 +1563146,7 @@ }, "comment": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -1550040,7 +1563520,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1550130,7 +1563610,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1554893,11 +1568373,11 @@ }, "pull-request-review-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "The content of a comment on a pull request diff was changed.", "operationId": "pull-request-review-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -1554991,7 +1568471,7 @@ }, "comment": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -1555365,7 +1568845,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1555455,7 +1568935,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1560223,11 +1573703,11 @@ }, "pull-request-review-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A review on a pull request was dismissed.", "operationId": "pull-request-review/dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -1560303,7 +1573783,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1560393,7 +1573873,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1565386,11 +1578866,11 @@ }, "pull-request-review-edited": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "The body comment on a pull request review was edited.", "operationId": "pull-request-review/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -1565483,7 +1578963,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1565573,7 +1579053,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1570441,11 +1583921,11 @@ }, "pull-request-review-request-removed": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A request for review by a person or team was removed from a pull request.", "operationId": "pull-request/review-request-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1570523,7 +1584003,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1570613,7 +1584093,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1575639,7 +1589119,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1575729,7 +1589209,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1580813,11 +1594293,11 @@ }, "pull-request-review-requested": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", "operationId": "pull-request/review-requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1580895,7 +1594375,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1580985,7 +1594465,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1586007,7 +1599487,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1586097,7 +1599577,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1591158,11 +1604638,11 @@ }, "pull-request-review-submitted": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A review on a pull request was submitted.", "operationId": "pull-request-review/submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -1591238,7 +1604718,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1591328,7 +1604808,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1596322,11 +1609802,11 @@ }, "pull-request-review-thread-resolved": { "post": { - "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A comment thread on a pull request was marked as resolved.", "operationId": "pull-request-review-thread/resolved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { @@ -1596402,7 +1609882,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1596492,7 +1609972,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1601169,7 +1614649,7 @@ "type": "array", "items": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -1601592,11 +1615072,11 @@ }, "pull-request-review-thread-unresolved": { "post": { - "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A previously resolved comment thread on a pull request was marked as unresolved.", "operationId": "pull-request-review-thread/unresolved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { @@ -1601672,7 +1615152,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1601762,7 +1615242,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1606419,7 +1619899,7 @@ "type": "array", "items": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -1606838,11 +1620318,11 @@ }, "pull-request-synchronize": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", "operationId": "pull-request/synchronize", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1606924,7 +1620404,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1607014,7 +1620494,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1611946,11 +1625426,11 @@ }, "pull-request-unassigned": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A user was unassigned from a pull request.", "operationId": "pull-request/unassigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1612126,7 +1625606,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1612216,7 +1625696,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1617155,11 +1630635,11 @@ }, "pull-request-unlabeled": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A label was removed from a pull request.", "operationId": "pull-request/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1617235,7 +1630715,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1617325,7 +1630805,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1622304,11 +1635784,11 @@ }, "pull-request-unlocked": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "pull-request/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1622384,7 +1635864,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1622474,7 +1635954,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1627393,7 +1640873,7 @@ "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", "operationId": "push", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -1627476,7 +1640956,7 @@ "type": "string" }, "commits": { - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-cloud@latest//rest/commits) to fetch additional commits.", + "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-cloud@latest/rest/commits) to fetch additional commits.", "type": "array", "items": { "title": "Commit", @@ -1627612,7 +1641092,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1627828,7 +1641308,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1628830,11 +1642310,11 @@ }, "registry-package-published": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", "description": "A package was published to a registry.", "operationId": "registry-package/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -1628909,7 +1642389,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1628999,7 +1642479,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1631674,11 +1645154,11 @@ }, "registry-package-updated": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", "description": "A package that was previously published to a registry was updated.", "operationId": "registry-package/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -1631753,7 +1645233,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1631843,7 +1645323,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1634217,11 +1647697,11 @@ }, "release-created": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", "operationId": "release/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1634297,7 +1647777,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1634387,7 +1647867,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1634511,7 +1647991,7 @@ }, "release": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object.", "type": "object", "properties": { "assets": { @@ -1636657,11 +1650137,11 @@ }, "release-deleted": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "description": "A release, pre-release, or draft release was deleted.", "operationId": "release/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1636737,7 +1650217,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1636827,7 +1650307,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1636951,7 +1650431,7 @@ }, "release": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object.", "type": "object", "properties": { "assets": { @@ -1639097,11 +1652577,11 @@ }, "release-edited": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", "operationId": "release/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1639230,7 +1652710,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1639320,7 +1652800,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1639444,7 +1652924,7 @@ }, "release": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object.", "type": "object", "properties": { "assets": { @@ -1641590,11 +1655070,11 @@ }, "release-prereleased": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", "operationId": "release/prereleased", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1641670,7 +1655150,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1641760,7 +1655240,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1641884,7 +1655364,7 @@ }, "release": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object.", "type": "object", "required": [ "assets", @@ -1644035,11 +1657515,11 @@ }, "release-published": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "description": "A release, pre-release, or draft of a release was published.", "operationId": "release/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1644115,7 +1657595,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1644205,7 +1657685,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1644329,7 +1657809,7 @@ }, "release": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object.", "type": "object", "required": [ "assets", @@ -1646477,11 +1659957,11 @@ }, "release-released": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "description": "A release was published, or a pre-release was changed to a release.", "operationId": "release/released", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1646557,7 +1660037,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1646647,7 +1660127,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1646771,7 +1660251,7 @@ }, "release": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object.", "type": "object", "properties": { "assets": { @@ -1648916,11 +1662396,11 @@ }, "release-unpublished": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "description": "A release or pre-release was unpublished.", "operationId": "release/unpublished", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -1648996,7 +1662476,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1649086,7 +1662566,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1649210,7 +1662690,7 @@ }, "release": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object.", "type": "object", "required": [ "assets", @@ -1651358,11 +1664838,11 @@ }, "repository-advisory-published": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", "description": "A repository security advisory was published.", "operationId": "repository-advisory/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -1651438,7 +1664918,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1651528,7 +1665008,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1655343,11 +1668823,11 @@ }, "repository-advisory-reported": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", "description": "A private vulnerability report was submitted.", "operationId": "repository-advisory/reported", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -1655423,7 +1668903,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1655513,7 +1668993,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1659328,11 +1672808,11 @@ }, "repository-archived": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "A repository was archived.", "operationId": "repository/archived", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1659408,7 +1672888,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1659498,7 +1672978,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1661323,11 +1674803,11 @@ }, "repository-created": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "A repository was created.", "operationId": "repository/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1661403,7 +1674883,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1661493,7 +1674973,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1663318,11 +1676798,11 @@ }, "repository-deleted": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", "operationId": "repository/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1663398,7 +1676878,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1663488,7 +1676968,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1665313,10 +1678793,10 @@ }, "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "repository-dispatch/sample.collected", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_dispatch" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_dispatch" }, "parameters": [ { @@ -1665401,7 +1678881,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1665491,7 +1678971,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1667316,11 +1680796,11 @@ }, "repository-edited": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "The topics, default branch, description, or homepage of a repository was changed.", "operationId": "repository/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1667454,7 +1680934,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1667544,7 +1681024,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1669370,10 +1682850,10 @@ }, "repository-import": { "post": { - "summary": "This event occurs when a repository is imported to GitHub Enterprise Cloud. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/enterprise-cloud@latest//get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports).", + "summary": "This event occurs when a repository is imported to GitHub Enterprise Cloud. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/enterprise-cloud@latest/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports).", "operationId": "repository-import", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_import" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_import" }, "parameters": [ { @@ -1669443,7 +1682923,7 @@ "properties": { "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1669533,7 +1683013,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1671364,11 +1684844,11 @@ }, "repository-privatized": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "The visibility of a repository was changed to `private`.", "operationId": "repository/privatized", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1671444,7 +1684924,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1671534,7 +1685014,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1673359,11 +1686839,11 @@ }, "repository-publicized": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "The visibility of a repository was changed to `public`.", "operationId": "repository/publicized", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1673439,7 +1686919,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1673529,7 +1687009,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1675354,11 +1688834,11 @@ }, "repository-renamed": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "The name of a repository was changed.", "operationId": "repository/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1675461,7 +1688941,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1675551,7 +1689031,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1677377,11 +1690857,11 @@ }, "repository-ruleset-created": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", "description": "A repository ruleset was created.", "operationId": "repository-ruleset/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -1677457,7 +1690937,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1677547,7 +1691027,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1679241,7 +1692721,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -1679251,7 +1692731,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -1680417,7 +1693898,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -1680427,7 +1693908,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -1680694,11 +1694175,11 @@ }, "repository-ruleset-deleted": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", "description": "A repository ruleset was deleted.", "operationId": "repository-ruleset/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -1680774,7 +1694255,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1680864,7 +1694345,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1682558,7 +1696039,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -1682568,7 +1696049,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -1683734,7 +1697216,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -1683744,7 +1697226,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -1684011,11 +1697493,11 @@ }, "repository-ruleset-edited": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", "description": "A repository ruleset was edited.", "operationId": "repository-ruleset/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -1684091,7 +1697573,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1684181,7 +1697663,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1685875,7 +1699357,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -1685885,7 +1699367,8 @@ "RepositoryRole", "Team", "DeployKey", - "EnterpriseOwner" + "EnterpriseOwner", + "EnterpriseRole" ], "description": "The type of actor that can bypass a ruleset" }, @@ -1687051,7 +1700534,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -1687061,7 +1700544,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -1688125,7 +1701608,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -1688135,7 +1701618,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -1689027,7 +1702510,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -1689037,7 +1702520,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -1689932,7 +1703415,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -1689942,7 +1703425,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -1690234,11 +1703717,11 @@ }, "repository-transferred": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", "operationId": "repository/transferred", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1690506,7 +1703989,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1690596,7 +1704079,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1692422,11 +1705905,11 @@ }, "repository-unarchived": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "A previously archived repository was unarchived.", "operationId": "repository/unarchived", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -1692502,7 +1705985,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1692592,7 +1706075,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1694421,7 +1707904,7 @@ "description": "A repository vulnerability alert was created.", "operationId": "repository-vulnerability-alert/create", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1694670,7 +1708153,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1694760,7 +1708243,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1696588,7 +1710071,7 @@ "description": "A repository vulnerability alert was dismissed.", "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1696848,7 +1710331,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1696938,7 +1710421,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1698766,7 +1712249,7 @@ "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1699015,7 +1712498,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1699105,7 +1712588,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1700933,7 +1714416,7 @@ "description": "A repository vulnerability alert was marked as resolved.", "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1701182,7 +1714665,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1701272,7 +1714755,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1703096,11 +1716579,11 @@ }, "secret-scanning-alert-assigned": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", "description": "A secret scanning alert was assigned.", "operationId": "secret-scanning-alert/assigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1703430,7 +1716913,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -1704392,7 +1717875,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1704482,7 +1717965,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1706306,11 +1719789,11 @@ }, "secret-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", "description": "A secret scanning alert was created.", "operationId": "secret-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1706640,7 +1720123,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -1707434,7 +1720917,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1707524,7 +1721007,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1709348,11 +1722831,11 @@ }, "secret-scanning-alert-location-created": { "post": { - "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -1709682,7 +1723165,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -1710476,7 +1723959,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1712896,11 +1726379,11 @@ }, "secret-scanning-alert-publicly-leaked": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", "description": "A secret scanning alert was detected in a public repo.", "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1713230,7 +1726713,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -1714024,7 +1727507,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1714114,7 +1727597,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1715938,11 +1729421,11 @@ }, "secret-scanning-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", "description": "A previously closed secret scanning alert was reopened.", "operationId": "secret-scanning-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1716272,7 +1729755,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -1717066,7 +1730549,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1717156,7 +1730639,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1718980,11 +1732463,11 @@ }, "secret-scanning-alert-resolved": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", "description": "A secret scanning alert was closed.", "operationId": "secret-scanning-alert/resolved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1719314,7 +1732797,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -1720108,7 +1733591,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1720198,7 +1733681,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1722022,11 +1735505,11 @@ }, "secret-scanning-alert-unassigned": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", "description": "A secret scanning alert was unassigned.", "operationId": "secret-scanning-alert/unassigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1722356,7 +1735839,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -1723318,7 +1736801,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1723408,7 +1736891,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1725232,11 +1738715,11 @@ }, "secret-scanning-alert-validated": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", "description": "A secret scanning alert was validated.", "operationId": "secret-scanning-alert/validated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1725566,7 +1739049,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -1726360,7 +1739843,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1726450,7 +1739933,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1728274,11 +1741757,11 @@ }, "secret-scanning-scan-completed": { "post": { - "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", "description": "A secret scanning scan was completed.", "operationId": "secret-scanning-scan/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_scan" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_scan" }, "parameters": [ { @@ -1729919,7 +1743402,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1730009,7 +1743492,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1730330,11 +1743813,11 @@ }, "security-advisory-published": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", "description": "A security advisory was published to the GitHub community.", "operationId": "security-advisory/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -1730410,7 +1743893,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1730500,7 +1743983,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1732549,11 +1746032,11 @@ }, "security-advisory-updated": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", "description": "The metadata or description of a security advisory was changed.", "operationId": "security-advisory/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -1732629,7 +1746112,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1732719,7 +1746202,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1734768,11 +1748251,11 @@ }, "security-advisory-withdrawn": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", "description": "A previously published security advisory was withdrawn.", "operationId": "security-advisory/withdrawn", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -1734848,7 +1748331,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1734938,7 +1748421,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1736984,10 +1750467,10 @@ }, "security-and-analysis": { "post": { - "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/enterprise-cloud@latest//code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/enterprise-cloud@latest/code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "operationId": "security-and-analysis", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_and_analysis" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#security_and_analysis" }, "parameters": [ { @@ -1737237,7 +1750720,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1737327,7 +1750810,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1741896,11 +1755379,11 @@ }, "sponsorship-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", "operationId": "sponsorship/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -1741976,7 +1755459,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1742066,7 +1755549,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1744213,11 +1757696,11 @@ }, "sponsorship-created": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.", "operationId": "sponsorship/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -1744293,7 +1757776,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1744383,7 +1757866,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1746530,11 +1760013,11 @@ }, "sponsorship-edited": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.", "operationId": "sponsorship/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -1746627,7 +1760110,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1746717,7 +1760200,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1748865,11 +1762348,11 @@ }, "sponsorship-pending-cancellation": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", "operationId": "sponsorship/pending-cancellation", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -1748949,7 +1762432,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1749039,7 +1762522,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1751186,11 +1764669,11 @@ }, "sponsorship-pending-tier-change": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.", "operationId": "sponsorship/pending-tier-change", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -1751329,7 +1764812,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1751419,7 +1764902,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1753567,11 +1767050,11 @@ }, "sponsorship-tier-changed": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.", "operationId": "sponsorship/tier-changed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -1753706,7 +1767189,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1753796,7 +1767279,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1755944,11 +1769427,11 @@ }, "star-created": { "post": { - "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "Someone starred a repository.", "operationId": "star/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -1756024,7 +1769507,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1756114,7 +1769597,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1757946,11 +1771429,11 @@ }, "star-deleted": { "post": { - "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "Someone unstarred the repository.", "operationId": "star/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -1758026,7 +1771509,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1758116,7 +1771599,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1759947,10 +1773430,10 @@ }, "status": { "post": { - "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", + "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", "operationId": "status", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#status" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#status" }, "parameters": [ { @@ -1760517,7 +1774000,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1760611,7 +1774094,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1762476,7 +1775959,7 @@ "description": "A parent issue was added to an issue.", "operationId": "sub-issues/parent-issue-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -1771250,7 +1784733,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1773081,7 +1786564,7 @@ "description": "A parent issue was removed from an issue.", "operationId": "sub-issues/parent-issue-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -1781855,7 +1795338,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1783686,7 +1797169,7 @@ "description": "A sub-issue was added to an issue.", "operationId": "sub-issues/sub-issue-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -1792460,7 +1805943,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1794291,7 +1807774,7 @@ "description": "A sub-issue was removed from an issue.", "operationId": "sub-issues/sub-issue-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -1803065,7 +1816548,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1804892,10 +1818375,10 @@ }, "team-add": { "post": { - "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "operationId": "team-add", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team_add" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team_add" }, "parameters": [ { @@ -1804965,7 +1818448,7 @@ "properties": { "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1805055,7 +1818538,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1807076,11 +1820559,11 @@ }, "team-added-to-repository": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A team was granted access to a repository.", "operationId": "team/added-to-repository", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -1807156,7 +1820639,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1807246,7 +1820729,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1808381,11 +1821864,11 @@ }, "team-created": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A team was created.", "operationId": "team/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -1808461,7 +1821944,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1808551,7 +1822034,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1809687,11 +1823170,11 @@ }, "team-deleted": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A team was deleted.", "operationId": "team/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -1809767,7 +1823250,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1809857,7 +1823340,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1810992,11 +1824475,11 @@ }, "team-edited": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "The name, description, or visibility of a team was changed.", "operationId": "team/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -1811159,7 +1824642,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1811249,7 +1824732,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1812386,11 +1825869,11 @@ }, "team-removed-from-repository": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A team's access to a repository was removed.", "operationId": "team/removed-from-repository", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -1812466,7 +1825949,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1812556,7 +1826039,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1813692,11 +1827175,11 @@ }, "watch-started": { "post": { - "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/enterprise-cloud@latest//account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/enterprise-cloud@latest/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/enterprise-cloud@latest/rest/activity/watching)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "Someone started watching the repository.", "operationId": "watch/started", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#watch" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#watch" }, "parameters": [ { @@ -1813772,7 +1827255,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1813862,7 +1827345,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1815686,10 +1829169,10 @@ }, "workflow-dispatch": { "post": { - "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/enterprise-cloud@latest//actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/enterprise-cloud@latest/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "workflow-dispatch", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_dispatch" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_dispatch" }, "parameters": [ { @@ -1815759,7 +1829242,7 @@ "properties": { "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1815856,7 +1829339,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1817686,11 +1831169,11 @@ }, "workflow-job-completed": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", "operationId": "workflow-job/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { @@ -1817766,7 +1831249,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1817856,7 +1831339,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1819699,7 +1833182,7 @@ "type": "integer" }, "labels": { - "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/enterprise-cloud@latest//actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", + "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/enterprise-cloud@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", "type": "array", "items": { "type": "string" @@ -1820737,11 +1834220,11 @@ }, "workflow-job-in-progress": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A job in a workflow run started processing on a runner.", "operationId": "workflow-job/in-progress", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { @@ -1820817,7 +1834300,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1820907,7 +1834390,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1822747,7 +1836230,7 @@ "type": "integer" }, "labels": { - "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/enterprise-cloud@latest//actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", + "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/enterprise-cloud@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", "type": "array", "items": { "type": "string" @@ -1823826,11 +1837309,11 @@ }, "workflow-job-queued": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A job in a workflow run was created.", "operationId": "workflow-job/queued", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { @@ -1823906,7 +1837389,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1823996,7 +1837479,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1826738,11 +1840221,11 @@ }, "workflow-job-waiting": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A job in a workflow run was created and is waiting for approvals.", "operationId": "workflow-job/waiting", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { @@ -1826818,7 +1840301,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1826908,7 +1840391,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1829651,11 +1843134,11 @@ }, "workflow-run-completed": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-cloud@latest//actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-cloud@latest/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.", "operationId": "workflow-run/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_run" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_run" }, "parameters": [ { @@ -1829731,7 +1843214,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1829821,7 +1843304,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1832950,11 +1846433,11 @@ }, "workflow-run-in-progress": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-cloud@latest//actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-cloud@latest/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A workflow run started processing on a runner.", "operationId": "workflow-run/in-progress", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_run" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_run" }, "parameters": [ { @@ -1833030,7 +1846513,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1833120,7 +1846603,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -1836231,11 +1849714,11 @@ }, "workflow-run-requested": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-cloud@latest//actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-cloud@latest/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A workflow run was triggered.", "operationId": "workflow-run/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_run" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_run" }, "parameters": [ { @@ -1836311,7 +1849794,7 @@ }, "enterprise": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -1836401,7 +1849884,7 @@ }, "installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 67a6302129..8f3d45e06c 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -73,10 +73,15 @@ tags: description: Interact with GitHub Teams. - name: users description: Interact with and view information about users and also current user. +- name: code-quality + description: Insights into reliability, maintainability, and efficiency of your + codebase. - name: codespaces description: Endpoints to manage Codespaces using the REST API. - name: copilot description: Endpoints to manage Copilot using the REST API. +- name: copilot-spaces + description: Endpoints to manage Copilot Spaces using the REST API. - name: enterprise-admin description: Enterprise Administration - name: scim @@ -309,20 +314,20 @@ paths: subcategory: meta externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#github-api-root + url: https://docs.github.com/enterprise-cloud@latest/rest/meta/meta#github-api-root "/advisories": get: summary: List global security advisories description: |- Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. - By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." + By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." tags: - security-advisories operationId: security-advisories/list-global-advisories externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#list-global-security-advisories + url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories#list-global-security-advisories parameters: - name: ghsa_id in: query @@ -415,7 +420,7 @@ paths: description: |- If specified, only return advisories that were published on a date or date range. - For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." schema: type: string - name: updated @@ -423,14 +428,14 @@ paths: description: |- If specified, only return advisories that were updated on a date or date range. - For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." schema: type: string - name: modified description: |- If specified, only show advisories that were updated or published on a date or date range. - For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." in: query schema: type: string @@ -450,18 +455,18 @@ paths: type: string - &108 name: before - description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For - more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: type: string - &109 name: after - description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For - more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: @@ -479,7 +484,7 @@ paths: default: desc - name: per_page description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -915,7 +920,7 @@ paths: - subscriptions_url - type - url - type: &445 + type: &449 type: string description: The type of credit the user is receiving. enum: @@ -1079,9 +1084,9 @@ paths: operationId: security-advisories/get-global-advisory externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory + url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &751 + - &755 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1175,15 +1180,15 @@ paths: get: summary: Get the authenticated app description: |- - Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. + Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-authenticated externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-the-authenticated-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-the-authenticated-app parameters: [] responses: '200': @@ -1417,7 +1422,7 @@ paths: post: summary: Create a GitHub App from a manifest description: Use this endpoint to complete the handshake necessary when implementing - the [GitHub App Manifest flow](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/creating-github-apps-from-a-manifest/). + the [GitHub App Manifest flow](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. tags: @@ -1425,7 +1430,7 @@ paths: operationId: apps/create-from-manifest externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-a-github-app-from-a-manifest + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#create-a-github-app-from-a-manifest parameters: - name: code in: path @@ -1541,13 +1546,13 @@ paths: description: |- Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-webhook-config-for-app externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#get-a-webhook-configuration-for-an-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/webhooks#get-a-webhook-configuration-for-an-app responses: '200': description: Response @@ -1574,7 +1579,7 @@ paths: type: string description: If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature - headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers). + headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers). examples: - '"********"' insecure_ssl: &11 @@ -1606,13 +1611,13 @@ paths: description: |- Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/update-webhook-config-for-app externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#update-a-webhook-configuration-for-an-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/webhooks#update-a-webhook-configuration-for-an-app requestBody: required: true content: @@ -1650,23 +1655,23 @@ paths: description: |- Returns a list of webhook deliveries for the webhook configured for a GitHub App. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/list-webhook-deliveries externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#list-deliveries-for-an-app-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/webhooks#list-deliveries-for-an-app-webhook parameters: - &17 name: per_page description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 30 - - &349 + - &353 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1675,7 +1680,7 @@ paths: required: false schema: type: string - - &350 + - &354 name: status description: Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries @@ -1695,7 +1700,7 @@ paths: application/json: schema: type: array - items: &351 + items: &355 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1791,7 +1796,7 @@ paths: - installation_id - repository_id examples: - default: &352 + default: &356 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1823,7 +1828,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &760 + schema: &764 title: Scim Error description: Scim Error type: object @@ -1907,13 +1912,13 @@ paths: description: |- Returns a delivery for the webhook configured for a GitHub App. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-webhook-delivery externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#get-a-delivery-for-an-app-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/webhooks#get-a-delivery-for-an-app-webhook parameters: - &16 name: delivery_id @@ -1926,7 +1931,7 @@ paths: description: Response content: application/json: - schema: &353 + schema: &357 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -2061,7 +2066,7 @@ paths: - request - response examples: - default: &354 + default: &358 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2111,13 +2116,13 @@ paths: description: |- Redeliver a delivery for the webhook configured for a GitHub App. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/redeliver-webhook-delivery externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook parameters: - *16 responses: @@ -2147,13 +2152,13 @@ paths: operationId: apps/list-installation-requests-for-authenticated-app externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#list-installation-requests-for-the-authenticated-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#list-installation-requests-for-the-authenticated-app parameters: - *17 - &19 name: page description: The page number of the results to fetch. For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -2255,13 +2260,13 @@ paths: description: |- The permissions the installation has are included under the `permissions` key. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/list-installations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#list-installations-for-the-authenticated-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#list-installations-for-the-authenticated-app parameters: - *17 - *19 @@ -2603,7 +2608,7 @@ paths: organization_copilot_agent_settings: type: string description: The level of permission to grant the access - token to view and manage Copilot coding agent settings + token to view and manage Copilot cloud agent settings for an organization. enum: - read @@ -2894,13 +2899,13 @@ paths: description: |- Enables an authenticated GitHub App to find an installation's information using the installation id. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-installation-for-the-authenticated-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-installation-for-the-authenticated-app parameters: - &21 name: installation_id @@ -2974,15 +2979,15 @@ paths: delete: summary: Delete an installation for the authenticated app description: |- - Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#suspend-an-app-installation)" endpoint. + Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#suspend-an-app-installation)" endpoint. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/delete-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#delete-an-installation-for-the-authenticated-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#delete-an-installation-for-the-authenticated-app parameters: - *21 responses: @@ -3006,13 +3011,13 @@ paths: Enterprise account installations do not have access to repositories and cannot be scoped down using the `permissions` parameter. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/create-installation-access-token externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-an-installation-access-token-for-an-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#create-an-installation-access-token-for-an-app parameters: - *21 requestBody: @@ -3852,13 +3857,13 @@ paths: description: |- Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Cloud API or webhook events is blocked for that account. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/suspend-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#suspend-an-app-installation + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#suspend-an-app-installation parameters: - *21 responses: @@ -3875,13 +3880,13 @@ paths: description: |- Removes a GitHub App installation suspension. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/unsuspend-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#unsuspend-an-app-installation + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#unsuspend-an-app-installation parameters: - *21 responses: @@ -3904,7 +3909,7 @@ paths: - apps externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/oauth-applications#delete-an-app-authorization + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/oauth-applications#delete-an-app-authorization parameters: - &24 name: client_id @@ -3954,7 +3959,7 @@ paths: operationId: apps/check-token externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/oauth-applications#check-a-token + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/oauth-applications#check-a-token parameters: - *24 requestBody: @@ -4164,7 +4169,7 @@ paths: operationId: apps/reset-token externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/oauth-applications#reset-a-token + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/oauth-applications#reset-a-token parameters: - *24 requestBody: @@ -4206,7 +4211,7 @@ paths: operationId: apps/delete-token externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/oauth-applications#delete-an-app-token + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/oauth-applications#delete-an-app-token parameters: - *24 requestBody: @@ -4249,7 +4254,7 @@ paths: operationId: apps/scope-token externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-a-scoped-access-token + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#create-a-scoped-access-token parameters: - *24 requestBody: @@ -4400,7 +4405,7 @@ paths: operationId: apps/get-by-slug externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-app parameters: - name: app_slug in: path @@ -4432,7 +4437,7 @@ paths: operationId: classroom/get-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#get-an-assignment + url: https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#get-an-assignment parameters: - &29 name: assignment_id @@ -4729,7 +4734,7 @@ paths: operationId: classroom/list-accepted-assignments-for-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#list-accepted-assignments-for-an-assignment + url: https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#list-accepted-assignments-for-an-assignment parameters: - *29 - *19 @@ -5025,7 +5030,7 @@ paths: operationId: classroom/get-assignment-grades externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#get-assignment-grades + url: https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#get-assignment-grades parameters: - *29 responses: @@ -5126,7 +5131,7 @@ paths: operationId: classroom/list-classrooms externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#list-classrooms + url: https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#list-classrooms parameters: - *19 - *17 @@ -5160,7 +5165,7 @@ paths: operationId: classroom/get-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#get-a-classroom + url: https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#get-a-classroom parameters: - &33 name: classroom_id @@ -5205,7 +5210,7 @@ paths: operationId: classroom/list-assignments-for-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#list-assignments-for-a-classroom + url: https://docs.github.com/enterprise-cloud@latest/rest/classroom/classroom#list-assignments-for-a-classroom parameters: - *33 - *19 @@ -5256,7 +5261,7 @@ paths: operationId: codes-of-conduct/get-all-codes-of-conduct externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct + url: https://docs.github.com/enterprise-cloud@latest/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct parameters: [] responses: '200': @@ -5368,7 +5373,7 @@ paths: operationId: codes-of-conduct/get-conduct-code externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct + url: https://docs.github.com/enterprise-cloud@latest/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct parameters: - name: key in: path @@ -5467,7 +5472,7 @@ paths: operationId: credentials/revoke externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/credentials/revoke#revoke-a-list-of-credentials + url: https://docs.github.com/enterprise-cloud@latest/rest/credentials/revoke#revoke-a-list-of-credentials requestBody: required: true content: @@ -5516,7 +5521,7 @@ paths: - emojis externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/emojis/emojis#get-emojis + url: https://docs.github.com/enterprise-cloud@latest/rest/emojis/emojis#get-emojis parameters: [] responses: '200': @@ -7429,7 +7434,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/admin-stats#get-github-enterprise-server-statistics + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/admin-stats#get-github-enterprise-server-statistics parameters: - name: enterprise_or_org description: The slug version of the enterprise name or the login of an organization. @@ -7438,14 +7443,14 @@ paths: schema: type: string - name: date_start - description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. in: query required: false schema: type: string - name: date_end - description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. in: query required: false @@ -7765,7 +7770,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprises#disable-access-restrictions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprises#disable-access-restrictions-for-an-enterprise parameters: - &39 name: enterprise @@ -7824,7 +7829,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprises#enable-access-restrictions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprises#enable-access-restrictions-for-an-enterprise parameters: - *39 responses: @@ -7860,7 +7865,7 @@ paths: operationId: actions/get-actions-cache-retention-limit-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise parameters: - *39 responses: @@ -7903,7 +7908,7 @@ paths: operationId: actions/set-actions-cache-retention-limit-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise parameters: - *39 requestBody: @@ -7937,7 +7942,7 @@ paths: operationId: actions/get-actions-cache-storage-limit-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise parameters: - *39 responses: @@ -7980,7 +7985,7 @@ paths: operationId: actions/set-actions-cache-storage-limit-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise parameters: - *39 requestBody: @@ -8014,7 +8019,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-usage-for-an-enterprise parameters: - *39 responses: @@ -8060,7 +8065,7 @@ paths: operationId: actions/list-hosted-runners-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-github-hosted-runners-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-github-hosted-runners-for-an-enterprise parameters: - *39 - *17 @@ -8310,7 +8315,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-enterprise parameters: - *39 requestBody: @@ -8432,7 +8437,7 @@ paths: operationId: actions/list-custom-images-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-custom-images-for-an-enterprise parameters: - *39 responses: @@ -8539,7 +8544,7 @@ paths: operationId: actions/get-custom-image-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-enterprise-custom-image-definition-for-github-actions-hosted-runners + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-an-enterprise-custom-image-definition-for-github-actions-hosted-runners parameters: - *39 - &48 @@ -8582,7 +8587,7 @@ paths: operationId: actions/delete-custom-image-from-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-a-custom-image-from-the-enterprise parameters: - *39 - *48 @@ -8606,7 +8611,7 @@ paths: operationId: actions/list-custom-image-versions-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-enterprise parameters: - *48 - *39 @@ -8682,7 +8687,7 @@ paths: operationId: actions/get-custom-image-version-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-an-enterprise-custom-image-for-github-actions-hosted-runners + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-an-image-version-of-an-enterprise-custom-image-for-github-actions-hosted-runners parameters: - *39 - *48 @@ -8723,7 +8728,7 @@ paths: operationId: actions/delete-custom-image-version-from-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-enterprise parameters: - *39 - *48 @@ -8746,7 +8751,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-enterprise parameters: - *39 responses: @@ -8826,7 +8831,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-enterprise parameters: - *39 responses: @@ -8861,7 +8866,7 @@ paths: operationId: actions/get-hosted-runners-limits-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-enterprise parameters: - *39 responses: @@ -8916,7 +8921,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-enterprise parameters: - *39 responses: @@ -8957,7 +8962,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-enterprise parameters: - *39 responses: @@ -9001,7 +9006,7 @@ paths: operationId: actions/get-hosted-runner-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-enterprise parameters: - *39 - &56 @@ -9036,7 +9041,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-enterprise parameters: - *39 - *56 @@ -9122,7 +9127,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-enterprise parameters: - *39 - *56 @@ -9151,7 +9156,7 @@ paths: operationId: actions/set-actions-oidc-custom-issuer-policy-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-github-actions-oidc-custom-issuer-policy-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#set-the-github-actions-oidc-custom-issuer-policy-for-an-enterprise parameters: - *39 responses: @@ -9191,7 +9196,7 @@ paths: operationId: oidc/list-oidc-custom-property-inclusions-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-enterprise parameters: - *39 responses: @@ -9247,7 +9252,7 @@ paths: operationId: oidc/create-oidc-custom-property-inclusion-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-enterprise parameters: - *39 requestBody: @@ -9299,7 +9304,7 @@ paths: operationId: oidc/delete-oidc-custom-property-inclusion-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-enterprise parameters: - *39 - name: custom_property_name @@ -9333,7 +9338,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-github-actions-permissions-for-an-enterprise parameters: - *39 responses: @@ -9399,7 +9404,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-github-actions-permissions-for-an-enterprise parameters: - *39 responses: @@ -9437,7 +9442,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-enterprise parameters: - *39 responses: @@ -9463,7 +9468,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &761 + '401': &765 description: Authorization failure '404': *6 x-github: @@ -9479,7 +9484,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-enterprise parameters: - *39 responses: @@ -9518,7 +9523,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-enterprise parameters: - *39 responses: @@ -9557,7 +9562,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-enterprise parameters: - *39 responses: @@ -9590,7 +9595,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-enterprise parameters: - *39 responses: @@ -9645,7 +9650,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-enterprise parameters: - *39 requestBody: @@ -9698,7 +9703,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise parameters: - *39 - *17 @@ -9822,7 +9827,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise parameters: - *39 responses: @@ -9866,7 +9871,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - *39 - &64 @@ -9895,7 +9900,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - *39 - *64 @@ -9919,7 +9924,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-enterprise parameters: - *39 responses: @@ -9971,7 +9976,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-enterprise parameters: - *39 responses: @@ -9999,7 +10004,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-permissions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-self-hosted-runners-permissions-for-an-enterprise parameters: - *39 responses: @@ -10035,7 +10040,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-permissions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-self-hosted-runners-permissions-for-an-enterprise parameters: - *39 responses: @@ -10072,7 +10077,7 @@ paths: description: |- Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: @@ -10080,7 +10085,7 @@ paths: operationId: actions/get-github-actions-default-workflow-permissions-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-default-workflow-permissions-for-an-enterprise parameters: - *39 responses: @@ -10121,7 +10126,7 @@ paths: description: |- Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets whether GitHub Actions can submit approving pull request reviews. For more information, see - "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: @@ -10129,7 +10134,7 @@ paths: operationId: actions/set-github-actions-default-workflow-permissions-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-default-workflow-permissions-for-an-enterprise parameters: - *39 requestBody: @@ -10163,7 +10168,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise parameters: - *39 - *17 @@ -10294,7 +10299,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-enterprise parameters: - *39 requestBody: @@ -10402,7 +10407,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise parameters: - *39 - &72 @@ -10436,7 +10441,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise parameters: - *39 - *72 @@ -10526,7 +10531,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise parameters: - *39 - *72 @@ -10550,7 +10555,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *39 - *72 @@ -10590,7 +10595,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise parameters: - *39 - *72 @@ -10636,7 +10641,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *39 - *72 @@ -10660,7 +10665,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *39 - *72 @@ -10685,7 +10690,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise parameters: - *39 - *72 @@ -10827,7 +10832,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise parameters: - *39 - *72 @@ -10872,7 +10877,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise parameters: - *39 - *72 @@ -10902,7 +10907,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise parameters: - *39 - *72 @@ -10927,7 +10932,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise parameters: - name: name description: The name of a self-hosted runner. @@ -10971,7 +10976,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-runner-applications-for-an-enterprise parameters: - *39 responses: @@ -11045,7 +11050,7 @@ paths: operationId: actions/generate-runner-jitconfig-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-enterprise parameters: - *39 requestBody: @@ -11159,7 +11164,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-registration-token-for-an-enterprise parameters: - *39 responses: @@ -11239,7 +11244,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-remove-token-for-an-enterprise parameters: - *39 responses: @@ -11270,7 +11275,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise parameters: - *39 - *75 @@ -11318,7 +11323,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise parameters: - *39 - *75 @@ -11343,7 +11348,7 @@ paths: operationId: enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise parameters: - *39 - *75 @@ -11397,7 +11402,7 @@ paths: operationId: enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise parameters: - *39 - *75 @@ -11444,7 +11449,7 @@ paths: operationId: enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise parameters: - *39 - *75 @@ -11492,7 +11497,7 @@ paths: operationId: enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise parameters: - *39 - *75 @@ -11549,7 +11554,7 @@ paths: operationId: enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise parameters: - *39 - *75 @@ -11578,7 +11583,7 @@ paths: operationId: announcement-banners/get-announcement-banner-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/enterprises#get-announcement-banner-for-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/enterprises#get-announcement-banner-for-enterprise parameters: - *39 responses: @@ -11598,7 +11603,7 @@ paths: - 'null' description: The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic - writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." + writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." examples: - Very **important** announcement about _something_. expires_at: &83 @@ -11645,7 +11650,7 @@ paths: operationId: announcement-banners/set-announcement-banner-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/enterprises#set-announcement-banner-for-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/enterprises#set-announcement-banner-for-enterprise requestBody: required: true content: @@ -11685,7 +11690,7 @@ paths: operationId: announcement-banners/remove-announcement-banner-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/enterprises#remove-announcement-banner-from-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/enterprises#remove-announcement-banner-from-enterprise parameters: - *39 responses: @@ -11708,7 +11713,7 @@ paths: operationId: enterprise-apps/installable-organizations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-enterprise-owned-organizations-that-can-have-github-apps-installed + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#get-enterprise-owned-organizations-that-can-have-github-apps-installed parameters: - *39 - *17 @@ -11767,7 +11772,7 @@ paths: operationId: enterprise-apps/installable-organization-accessible-repositories externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-repositories-belonging-to-an-enterprise-owned-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#get-repositories-belonging-to-an-enterprise-owned-organization parameters: - *39 - &87 @@ -11838,7 +11843,7 @@ paths: operationId: enterprise-apps/organization-installations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#list-github-apps-installed-on-an-enterprise-owned-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#list-github-apps-installed-on-an-enterprise-owned-organization parameters: - *39 - *87 @@ -11937,7 +11942,7 @@ paths: operationId: enterprise-apps/create-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#install-a-github-app-on-an-enterprise-owned-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#install-a-github-app-on-an-enterprise-owned-organization parameters: - *39 - *87 @@ -12020,7 +12025,7 @@ paths: operationId: enterprise-apps/delete-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#uninstall-a-github-app-from-an-enterprise-owned-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#uninstall-a-github-app-from-an-enterprise-owned-organization parameters: - *39 - *87 @@ -12048,7 +12053,7 @@ paths: operationId: enterprise-apps/organization-installation-repositories externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-the-repositories-accessible-to-a-given-github-app-installation + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#get-the-repositories-accessible-to-a-given-github-app-installation parameters: - *39 - *87 @@ -12089,7 +12094,7 @@ paths: operationId: enterprise-apps/change-installation-repository-access-selection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#toggle-installation-repository-access-between-selected-and-all-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#toggle-installation-repository-access-between-selected-and-all-repositories parameters: - *39 - *87 @@ -12150,7 +12155,7 @@ paths: operationId: enterprise-apps/grant-repository-access-to-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#grant-repository-access-to-an-organization-installation + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#grant-repository-access-to-an-organization-installation parameters: - *39 - *87 @@ -12211,7 +12216,7 @@ paths: operationId: enterprise-apps/remove-repository-access-to-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#remove-repository-access-from-an-organization-installation + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/organization-installations#remove-repository-access-from-an-organization-installation parameters: - *39 - *87 @@ -12282,7 +12287,7 @@ paths: description: |- Gets the audit log for an enterprise. - This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators)." + This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-integrators)." The authenticated user must be an enterprise admin to use this endpoint. @@ -12291,12 +12296,12 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#get-the-audit-log-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#get-the-audit-log-for-an-enterprise parameters: - *39 - name: phrase description: A search phrase. For more information, see [Searching the audit - log](https://docs.github.com/enterprise-cloud@latest//admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). + log](https://docs.github.com/enterprise-cloud@latest/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). in: query required: false schema: @@ -12321,7 +12326,7 @@ paths: - all - &297 name: after - description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. in: query required: false @@ -12329,7 +12334,7 @@ paths: type: string - &298 name: before - description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. in: query required: false @@ -12520,7 +12525,7 @@ paths: operationId: enterprise-admin/get-audit-log-stream-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#get-the-audit-log-stream-key-for-encrypting-secrets + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#get-the-audit-log-stream-key-for-encrypting-secrets parameters: - *39 responses: @@ -12564,7 +12569,7 @@ paths: operationId: enterprise-admin/get-audit-log-streams externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#list-audit-log-stream-configurations-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#list-audit-log-stream-configurations-for-an-enterprise parameters: - *39 responses: @@ -12631,7 +12636,7 @@ paths: operationId: enterprise-admin/create-audit-log-stream externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#create-an-audit-log-streaming-configuration-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#create-an-audit-log-streaming-configuration-for-an-enterprise parameters: - *39 requestBody: @@ -12940,7 +12945,7 @@ paths: operationId: enterprise-admin/get-one-audit-log-stream externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#list-one-audit-log-streaming-configuration-via-a-stream-id + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#list-one-audit-log-streaming-configuration-via-a-stream-id parameters: - *39 - &92 @@ -12974,7 +12979,7 @@ paths: operationId: enterprise-admin/update-audit-log-stream externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#update-an-existing-audit-log-stream-configuration + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#update-an-existing-audit-log-stream-configuration parameters: - *39 - *92 @@ -13052,7 +13057,7 @@ paths: operationId: enterprise-admin/delete-audit-log-stream externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#delete-an-audit-log-streaming-configuration-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/audit-log#delete-an-audit-log-streaming-configuration-for-an-enterprise parameters: - *39 - *92 @@ -13074,7 +13079,7 @@ paths: operationId: enterprise-admin/list-push-bypass-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/bypass-requests#list-push-rule-bypass-requests-within-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/bypass-requests#list-push-rule-bypass-requests-within-an-enterprise x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -13402,7 +13407,7 @@ paths: operationId: secret-scanning/list-enterprise-bypass-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-enterprise x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -13627,7 +13632,7 @@ paths: get: summary: List code scanning alerts for an enterprise description: |- - Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." The authenticated user must be a member of the enterprise to use this endpoint. @@ -13637,7 +13642,7 @@ paths: operationId: code-scanning/list-alerts-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *39 - &311 @@ -13736,7 +13741,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &534 + instances_url: &538 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -13772,7 +13777,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &535 + dismissed_reason: &539 type: - string - 'null' @@ -13783,14 +13788,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &536 + dismissed_comment: &540 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &537 + rule: &541 type: object properties: id: @@ -13851,7 +13856,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &538 + tool: &542 type: object properties: name: *111 @@ -13862,26 +13867,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *112 - most_recent_instance: &539 + most_recent_instance: &543 type: object properties: - ref: &532 + ref: &536 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &549 + analysis_key: &553 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - environment: &550 + environment: &554 type: string description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &551 + category: &555 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -13901,7 +13906,7 @@ paths: with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance. - location: &552 + location: &556 type: object description: Describe a region within a file for the alert. properties: @@ -13922,7 +13927,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: &553 + items: &557 type: - string - 'null' @@ -14542,13 +14547,13 @@ paths: operationId: code-security/get-configurations-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise parameters: - *39 - name: per_page in: query description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." required: false schema: type: integer @@ -14887,7 +14892,7 @@ paths: operationId: code-security/create-configuration-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise parameters: - *39 requestBody: @@ -15165,7 +15170,7 @@ paths: operationId: code-security/get-default-configurations-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise parameters: - *39 responses: @@ -15270,7 +15275,7 @@ paths: operationId: code-security/get-single-configuration-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise parameters: - *39 - &116 @@ -15309,7 +15314,7 @@ paths: operationId: code-security/update-enterprise-configuration externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise parameters: - *39 - *116 @@ -15515,7 +15520,7 @@ paths: operationId: code-security/delete-configuration-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise parameters: - *39 - *116 @@ -15547,7 +15552,7 @@ paths: operationId: code-security/attach-enterprise-configuration externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories parameters: - *39 - *116 @@ -15599,7 +15604,7 @@ paths: operationId: code-security/set-configuration-as-default-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise parameters: - *39 - *116 @@ -15706,13 +15711,13 @@ paths: operationId: code-security/get-repositories-for-enterprise-configuration externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration parameters: - *39 - *116 - name: per_page description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: @@ -15841,7 +15846,7 @@ paths: summary: Get code security and analysis features for an enterprise description: |- > [!WARNING] - > **Closing down notice:** The ability to fetch code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + > **Closing down notice:** The ability to fetch code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). Gets code security and analysis settings for the specified enterprise. @@ -15853,7 +15858,7 @@ paths: operationId: secret-scanning/get-security-analysis-settings-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/code-security-and-analysis#get-code-security-and-analysis-features-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/code-security-and-analysis#get-code-security-and-analysis-features-for-an-enterprise parameters: - *39 responses: @@ -15948,7 +15953,7 @@ paths: summary: Update code security and analysis features for an enterprise description: |- > [!WARNING] - > **Closing down notice:** The ability to update code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + > **Closing down notice:** The ability to update code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. @@ -15960,7 +15965,7 @@ paths: operationId: secret-scanning/patch-security-analysis-settings-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/code-security-and-analysis#update-code-security-and-analysis-features-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/code-security-and-analysis#update-code-security-and-analysis-features-for-an-enterprise parameters: - *39 requestBody: @@ -15974,32 +15979,32 @@ paths: type: boolean description: Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see "[About GitHub - Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security)." + Advanced Security](https://docs.github.com/enterprise-cloud@latest/get-started/learning-about-github/about-github-advanced-security)." advanced_security_enabled_new_user_namespace_repos: type: boolean description: Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. For more information, see - "[About GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security)." + "[About GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest/get-started/learning-about-github/about-github-advanced-security)." dependabot_alerts_enabled_for_new_repositories: type: boolean description: Whether Dependabot alerts are automatically enabled for new repositories. For more information, see "[About Dependabot - alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." secret_scanning_enabled_for_new_repositories: type: boolean description: Whether secret scanning is automatically enabled for - new repositories. For more information, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." + new repositories. For more information, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." secret_scanning_push_protection_enabled_for_new_repositories: type: boolean description: Whether secret scanning push protection is automatically enabled for new repositories. For more information, see "[Protecting - pushes with secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + pushes with secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." secret_scanning_push_protection_custom_link: type: - string - 'null' description: |- - The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." To disable this functionality, set this field to `null`. secret_scanning_non_provider_patterns_enabled_for_new_repositories: type: @@ -16046,7 +16051,7 @@ paths: operationId: enterprise-admin/get-consumed-licenses externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#list-enterprise-consumed-licenses + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/licensing#list-enterprise-consumed-licenses parameters: - *39 - *17 @@ -16208,7 +16213,7 @@ paths: For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, - see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data). + see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/reference/metrics-data). Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. @@ -16218,13 +16223,13 @@ paths: operationId: copilot/list-copilot-seats-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-enterprise parameters: - *39 - *19 - name: per_page description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -16339,7 +16344,7 @@ paths: parent: anyOf: - type: 'null' - - &389 + - &393 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -16679,7 +16684,7 @@ paths: operationId: copilot/add-copilot-seats-for-enterprise-teams externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-enterprise-teams-to-the-copilot-subscription-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#add-enterprise-teams-to-the-copilot-subscription-for-an-enterprise parameters: - *39 requestBody: @@ -16755,7 +16760,7 @@ paths: operationId: copilot/cancel-copilot-seats-for-enterprise-teams externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-enterprise-teams-from-the-copilot-subscription-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#remove-enterprise-teams-from-the-copilot-subscription-for-an-enterprise parameters: - *39 requestBody: @@ -16845,7 +16850,7 @@ paths: operationId: copilot/add-copilot-seats-for-enterprise-users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-enterprise parameters: - *39 requestBody: @@ -16921,7 +16926,7 @@ paths: operationId: copilot/cancel-copilot-seats-for-enterprise-users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-enterprise parameters: - *39 requestBody: @@ -16988,7 +16993,7 @@ paths: Gets information about an enterprise's Copilot content exclusion path rules. To configure these settings, go to the enterprise's settings on GitHub. - For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-enterprise)." + For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-enterprise)." Enterprise owners can view details about Copilot content exclusion rules for the enterprise. @@ -17002,7 +17007,7 @@ paths: operationId: copilot/copilot-content-exclusion-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-enterprise parameters: - *39 responses: @@ -17043,7 +17048,7 @@ paths: Sets Copilot content exclusion path rules for an enterprise. To configure these settings, go to the enterprise's settings on GitHub. - For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-enterprise)." + For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-enterprise)." Enterprise owners can set Copilot content exclusion rules for the enterprise. @@ -17057,7 +17062,7 @@ paths: operationId: copilot/set-copilot-content-exclusion-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-enterprise parameters: - *39 requestBody: @@ -17117,7 +17122,7 @@ paths: '401': *23 '403': *27 '404': *6 - '413': &323 + '413': &327 description: Payload Too Large content: application/json: @@ -17144,7 +17149,7 @@ paths: operationId: copilot/get-copilot-custom-agents-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-custom-agents#get-custom-agents-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-custom-agents#get-custom-agents-for-an-enterprise parameters: - *39 - *17 @@ -17231,7 +17236,7 @@ paths: operationId: copilot/get-copilot-custom-agents-source-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-custom-agents#get-the-source-organization-for-custom-agents-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-custom-agents#get-the-source-organization-for-custom-agents-in-an-enterprise parameters: - *39 responses: @@ -17312,7 +17317,7 @@ paths: operationId: copilot/set-copilot-custom-agents-source-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-custom-agents#set-the-source-organization-for-custom-agents-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-custom-agents#set-the-source-organization-for-custom-agents-in-an-enterprise parameters: - *39 requestBody: @@ -17467,7 +17472,7 @@ paths: operationId: copilot/delete-copilot-custom-agents-source-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-custom-agents#delete-the-custom-agents-source-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-custom-agents#delete-the-custom-agents-source-for-an-enterprise x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -17508,7 +17513,7 @@ paths: operationId: copilot/copilot-metrics-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise parameters: - *39 - name: since @@ -17530,7 +17535,7 @@ paths: - *19 - name: per_page description: The number of days of metrics to display per page (max 100). - For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -17986,7 +17991,7 @@ paths: operationId: copilot/copilot-enterprise-one-day-usage-metrics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day parameters: - *39 - &121 @@ -18055,7 +18060,7 @@ paths: operationId: copilot/copilot-enterprise-usage-metrics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics parameters: - *39 responses: @@ -18122,7 +18127,7 @@ paths: operationId: copilot/copilot-users-one-day-usage-metrics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day parameters: - *39 - *121 @@ -18158,7 +18163,7 @@ paths: operationId: copilot/copilot-users-usage-metrics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics parameters: - *39 responses: @@ -18181,9 +18186,9 @@ paths: put: summary: Set the coding agent policy for an enterprise description: |- - Sets the policy for Copilot coding agent usage across an enterprise. + Sets the policy for Copilot cloud agent usage across an enterprise. - Enterprise owners can configure whether Copilot coding agent is enabled for all + Enterprise owners can configure whether Copilot cloud agent is enabled for all organizations, disabled for all organizations, configured by individual organization admins, or enabled for selected organizations only. @@ -18195,7 +18200,7 @@ paths: operationId: copilot/set-enterprise-coding-agent-policy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#set-the-coding-agent-policy-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#set-the-coding-agent-policy-for-an-enterprise parameters: - *39 requestBody: @@ -18208,7 +18213,7 @@ paths: properties: policy_state: type: string - description: The policy state for Copilot coding agent in the enterprise. + description: The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`. enum: @@ -18234,7 +18239,7 @@ paths: post: summary: Add organizations to the enterprise coding agent policy description: |- - Enables Copilot coding agent for the specified organizations within the enterprise. + Enables Copilot cloud agent for the specified organizations within the enterprise. The enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before using this endpoint. Organizations can be specified by login or matched via custom properties. @@ -18249,11 +18254,11 @@ paths: operationId: copilot/add-organizations-to-enterprise-coding-agent-policy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#add-organizations-to-the-enterprise-coding-agent-policy + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#add-organizations-to-the-enterprise-coding-agent-policy parameters: - *39 requestBody: - description: The organizations to enable Copilot coding agent for + description: The organizations to enable Copilot cloud agent for required: true content: application/json: @@ -18263,7 +18268,7 @@ paths: organizations: type: array description: List of organization logins within the enterprise to - enable Copilot coding agent for. + enable Copilot cloud agent for. items: type: string custom_properties: @@ -18309,7 +18314,7 @@ paths: delete: summary: Remove organizations from the enterprise coding agent policy description: |- - Disables Copilot coding agent for the specified organizations within the enterprise. + Disables Copilot cloud agent for the specified organizations within the enterprise. The enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before using this endpoint. Organizations can be specified by login or matched via custom properties. @@ -18324,11 +18329,11 @@ paths: operationId: copilot/remove-organizations-from-enterprise-coding-agent-policy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#remove-organizations-from-the-enterprise-coding-agent-policy + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#remove-organizations-from-the-enterprise-coding-agent-policy parameters: - *39 requestBody: - description: The organizations to disable Copilot coding agent for + description: The organizations to disable Copilot cloud agent for required: true content: application/json: @@ -18338,7 +18343,7 @@ paths: organizations: type: array description: List of organization logins within the enterprise to - disable Copilot coding agent for. + disable Copilot cloud agent for. items: type: string custom_properties: @@ -18390,7 +18395,7 @@ paths: The authenticated user must be a member of the enterprise to use this endpoint. - Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. tags: @@ -18398,10 +18403,10 @@ paths: operationId: dependabot/list-alerts-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *39 - - &328 + - &332 name: classification in: query description: |- @@ -18410,7 +18415,7 @@ paths: Can be: `malware`, `general` schema: type: string - - &329 + - &333 name: state in: query description: |- @@ -18419,7 +18424,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &330 + - &334 name: severity in: query description: |- @@ -18428,7 +18433,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &331 + - &335 name: ecosystem in: query description: |- @@ -18437,14 +18442,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &332 + - &336 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &333 + - &337 name: epss_percentage in: query description: |- @@ -18456,7 +18461,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &592 + - &596 name: has in: query description: |- @@ -18470,7 +18475,7 @@ paths: type: string enum: - patch - - &334 + - &338 name: assignee in: query description: |- @@ -18479,7 +18484,7 @@ paths: Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. schema: type: string - - &335 + - &339 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -18489,7 +18494,7 @@ paths: enum: - development - runtime - - &336 + - &340 name: sort in: query description: |- @@ -18515,7 +18520,7 @@ paths: application/json: schema: type: array - items: &337 + items: &341 type: object description: A Dependabot alert. properties: @@ -18583,7 +18588,7 @@ paths: - transitive - inconclusive - - security_advisory: &593 + security_advisory: &597 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -18826,7 +18831,7 @@ paths: dismissal. maxLength: 280 fixed_at: *137 - auto_dismissed_at: &594 + auto_dismissed_at: &598 type: - string - 'null' @@ -18834,7 +18839,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissal_request: &595 + dismissal_request: &599 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -18897,7 +18902,7 @@ paths: - repository additionalProperties: false examples: - default: &338 + default: &342 value: - number: 2 state: dismissed @@ -19257,7 +19262,7 @@ paths: operationId: dependabot/repository-access-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-enterprise parameters: - *39 - name: page @@ -19282,7 +19287,7 @@ paths: description: Response content: application/json: - schema: &339 + schema: &343 title: Dependabot Repository Access Details description: Information about repositories that Dependabot is able to access in an organization @@ -19308,7 +19313,7 @@ paths: - *120 additionalProperties: false examples: - default: &340 + default: &344 value: default_level: public accessible_repositories: @@ -19406,7 +19411,7 @@ paths: operationId: dependabot/update-repository-access-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-enterprise parameters: - *39 requestBody: @@ -19470,7 +19475,7 @@ paths: operationId: dependabot/set-repository-access-default-level-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot-in-an-enterprise parameters: - *39 requestBody: @@ -19519,7 +19524,7 @@ paths: operationId: secret-scanning/list-enterprise-dismissal-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-an-enterprise x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -19531,7 +19536,7 @@ paths: - *103 - *104 - *105 - - &342 + - &346 name: request_status description: The status of the dismissal request to filter on. When specified, only requests with this status will be returned. @@ -19557,7 +19562,7 @@ paths: application/json: schema: type: array - items: &344 + items: &348 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -19684,7 +19689,7 @@ paths: examples: - https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &345 + default: &349 value: - id: 21 number: 42 @@ -19767,7 +19772,7 @@ paths: operationId: enterprise-admin/list-enterprise-roles externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#get-all-enterprise-roles-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#get-all-enterprise-roles-for-an-enterprise parameters: - *39 responses: @@ -19910,7 +19915,7 @@ paths: operationId: enterprise-admin/revoke-all-enterprise-roles-team externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-team parameters: - *39 - &138 @@ -19953,7 +19958,7 @@ paths: operationId: enterprise-admin/assign-team-to-enterprise-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-a-team parameters: - *39 - *138 @@ -19996,7 +20001,7 @@ paths: operationId: enterprise-admin/revoke-enterprise-role-team externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-an-enterprise-role-from-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#remove-an-enterprise-role-from-a-team parameters: - *39 - *138 @@ -20031,7 +20036,7 @@ paths: operationId: enterprise-admin/remove-all-enterprise-roles-from-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-user parameters: - *39 - &140 @@ -20071,7 +20076,7 @@ paths: operationId: enterprise-admin/assign-enterprise-role-to-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-an-enterprise-user + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-an-enterprise-user parameters: - *39 - *140 @@ -20105,7 +20110,7 @@ paths: operationId: enterprise-admin/remove-enterprise-user-role-assignment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-enterprise-user-role-assignment + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#remove-enterprise-user-role-assignment parameters: - *39 - *140 @@ -20140,7 +20145,7 @@ paths: operationId: enterprise-admin/get-enterprise-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#get-an-enterprise-role + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#get-an-enterprise-role parameters: - *39 - *139 @@ -20200,7 +20205,7 @@ paths: operationId: enterprise-admin/list-enterprise-role-teams externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#list-teams-that-are-assigned-to-an-enterprise-role + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#list-teams-that-are-assigned-to-an-enterprise-role parameters: - *39 - *139 @@ -20251,7 +20256,7 @@ paths: operationId: enterprise-admin/list-enterprise-role-users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#list-users-that-are-assigned-to-an-enterprise-role + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#list-users-that-are-assigned-to-an-enterprise-role parameters: - *39 - *139 @@ -20363,13 +20368,13 @@ paths: description: |- Enables an authenticated GitHub App to find its installation on a particular enterprise. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-enterprise-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-enterprise-installation-for-the-authenticated-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-enterprise-installation-for-the-authenticated-app parameters: - *39 responses: @@ -20379,7 +20384,7 @@ paths: application/json: schema: *20 examples: - default: &366 + default: &370 value: id: 1 account: @@ -20445,7 +20450,7 @@ paths: operationId: enterprise-admin/get-license-sync-status externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#get-a-license-sync-status + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/licensing#get-a-license-sync-status parameters: - *39 responses: @@ -20517,7 +20522,7 @@ paths: operationId: copilot/get-copilot-seat-details-for-enterprise-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-an-enterprise-user + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-an-enterprise-user parameters: - *39 - *140 @@ -20561,7 +20566,7 @@ paths: operationId: hosted-compute/list-network-configurations-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#list-hosted-compute-network-configurations-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#list-hosted-compute-network-configurations-for-an-enterprise parameters: - *39 - *17 @@ -20640,7 +20645,7 @@ paths: - name - created_on examples: - default: &449 + default: &453 value: total_count: 2 network_configurations: @@ -20674,7 +20679,7 @@ paths: operationId: hosted-compute/create-network-configuration-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#create-a-hosted-compute-network-configuration-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#create-a-hosted-compute-network-configuration-for-an-enterprise parameters: - *39 requestBody: @@ -20758,7 +20763,7 @@ paths: operationId: hosted-compute/get-network-configuration-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-configuration-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-configuration-for-an-enterprise parameters: - *39 - &147 @@ -20792,7 +20797,7 @@ paths: operationId: hosted-compute/update-network-configuration-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#update-a-hosted-compute-network-configuration-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#update-a-hosted-compute-network-configuration-for-an-enterprise parameters: - *39 - *147 @@ -20865,7 +20870,7 @@ paths: operationId: hosted-compute/delete-network-configuration-from-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#delete-a-hosted-compute-network-configuration-from-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#delete-a-hosted-compute-network-configuration-from-an-enterprise parameters: - *39 - *147 @@ -20888,10 +20893,10 @@ paths: operationId: hosted-compute/get-network-settings-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - *39 - - &450 + - &454 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -20903,7 +20908,7 @@ paths: description: Response content: application/json: - schema: &451 + schema: &455 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -20942,7 +20947,7 @@ paths: - subnet_id - region examples: - default: &452 + default: &456 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -20971,7 +20976,7 @@ paths: operationId: enterprise-admin/custom-properties-for-orgs-get-enterprise-definitions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-organization-custom-properties-schema-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#get-organization-custom-properties-schema-for-an-enterprise parameters: - *39 responses: @@ -21105,7 +21110,7 @@ paths: operationId: enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definitions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-organization-custom-property-definitions-on-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#create-or-update-organization-custom-property-definitions-on-an-enterprise parameters: - *39 requestBody: @@ -21178,7 +21183,7 @@ paths: operationId: enterprise-admin/custom-properties-for-orgs-get-enterprise-definition externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-an-organization-custom-property-definition-from-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#get-an-organization-custom-property-definition-from-an-enterprise parameters: - *39 - &150 @@ -21229,7 +21234,7 @@ paths: operationId: enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definition externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-an-organization-custom-property-definition-on-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#create-or-update-an-organization-custom-property-definition-on-an-enterprise parameters: - *39 - *150 @@ -21335,7 +21340,7 @@ paths: operationId: enterprise-admin/custom-properties-for-orgs-delete-enterprise-definition externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#remove-an-organization-custom-property-definition-from-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#remove-an-organization-custom-property-definition-from-an-enterprise parameters: - *39 - *150 @@ -21364,7 +21369,7 @@ paths: operationId: enterprise-admin/custom-properties-for-orgs-get-enterprise-values externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#list-custom-property-values-for-organizations-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#list-custom-property-values-for-organizations-in-an-enterprise parameters: - *39 - *17 @@ -21455,7 +21460,7 @@ paths: operationId: enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-values externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-custom-property-values-for-organizations-in-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties-for-orgs#create-or-update-custom-property-values-for-organizations-in-an-enterprise parameters: - *39 requestBody: @@ -21517,7 +21522,7 @@ paths: operationId: enterprise-admin/custom-properties-for-repos-get-enterprise-definitions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-custom-properties-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#get-custom-properties-for-an-enterprise parameters: - *39 responses: @@ -21650,7 +21655,7 @@ paths: operationId: enterprise-admin/custom-properties-for-repos-create-or-update-enterprise-definitions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-custom-properties-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#create-or-update-custom-properties-for-an-enterprise parameters: - *39 requestBody: @@ -21715,7 +21720,7 @@ paths: operationId: enterprise-admin/custom-properties-for-repos-promote-definition-to-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#promote-a-custom-property-to-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#promote-a-custom-property-to-an-enterprise parameters: - *39 - *87 @@ -21757,7 +21762,7 @@ paths: operationId: enterprise-admin/custom-properties-for-repos-get-enterprise-definition externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise parameters: - *39 - *150 @@ -21787,7 +21792,7 @@ paths: operationId: enterprise-admin/custom-properties-for-repos-create-or-update-enterprise-definition externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-for-an-enterprise parameters: - *39 - *150 @@ -21795,7 +21800,7 @@ paths: required: true content: application/json: - schema: &420 + schema: &424 title: Custom Property Set Payload description: Custom property set payload type: object @@ -21891,7 +21896,7 @@ paths: operationId: enterprise-admin/custom-properties-for-repos-delete-enterprise-definition externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise parameters: - *39 - *150 @@ -21913,7 +21918,7 @@ paths: operationId: repos/create-enterprise-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#create-an-enterprise-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#create-an-enterprise-repository-ruleset parameters: - *39 requestBody: @@ -21965,8 +21970,8 @@ paths: actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` - is ignored. `OrganizationAdmin` and `EnterpriseOwner` are - not applicable for personal repositories. + is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` + are not applicable for personal repositories. actor_type: type: string enum: @@ -21976,6 +21981,7 @@ paths: - Team - DeployKey - EnterpriseOwner + - EnterpriseRole description: The type of actor that can bypass a ruleset bypass_mode: type: string @@ -22847,7 +22853,7 @@ paths: description: The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity - levels, see "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + levels, see "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." enum: - none - errors @@ -22859,7 +22865,7 @@ paths: scanning results that raise security alerts block a reference update. For more information on security severity levels, see "[About code - scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." enum: - none - critical @@ -22997,7 +23003,7 @@ paths: conditions: anyOf: - *158 - - &424 + - &428 title: Organization ruleset conditions type: object description: |- @@ -23047,7 +23053,7 @@ paths: - object rules: type: array - items: &717 + items: &721 title: Repository Rule type: object description: A repository rule. @@ -23056,7 +23062,7 @@ paths: - *167 - *168 - *169 - - &715 + - &719 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -23203,7 +23209,7 @@ paths: operationId: repos/get-enterprise-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-an-enterprise-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#get-an-enterprise-repository-ruleset parameters: - *39 - name: ruleset_id @@ -23235,7 +23241,7 @@ paths: operationId: repos/update-enterprise-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#update-an-enterprise-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#update-an-enterprise-repository-ruleset parameters: - *39 - name: ruleset_id @@ -23314,7 +23320,7 @@ paths: operationId: repos/delete-enterprise-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#delete-an-enterprise-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#delete-an-enterprise-repository-ruleset parameters: - *39 - name: ruleset_id @@ -23342,7 +23348,7 @@ paths: operationId: enterprise-admin/get-enterprise-ruleset-history externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-enterprise-ruleset-history + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#get-enterprise-ruleset-history parameters: - *39 - *17 @@ -23384,7 +23390,7 @@ paths: type: string format: date-time examples: - default: &427 + default: &431 value: - version_id: 3 actor: @@ -23417,7 +23423,7 @@ paths: operationId: enterprise-admin/get-enterprise-ruleset-version externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-enterprise-ruleset-version + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/rules#get-enterprise-ruleset-version parameters: - *39 - name: ruleset_id @@ -23437,7 +23443,7 @@ paths: description: Response content: application/json: - schema: &428 + schema: &432 allOf: - *191 - type: object @@ -23483,16 +23489,16 @@ paths: summary: List secret scanning alerts for an enterprise description: |- Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for repositories owned by enterprise managed users. + To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for repositories owned by enterprise managed users. tags: - secret-scanning operationId: secret-scanning/list-alerts-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *39 - - &429 + - &433 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -23503,28 +23509,28 @@ paths: enum: - open - resolved - - &430 + - &434 name: secret_type in: query description: A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token - name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" + name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. required: false schema: type: string - - &431 + - &435 name: exclude_secret_types in: query description: A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the `secret_type` parameter. See "[Supported - secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" + secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. required: false schema: type: string - - &432 + - &436 name: exclude_providers in: query description: |- @@ -23535,7 +23541,7 @@ paths: required: false schema: type: string - - &433 + - &437 name: providers in: query description: |- @@ -23546,7 +23552,7 @@ paths: required: false schema: type: string - - &434 + - &438 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -23555,7 +23561,7 @@ paths: required: false schema: type: string - - &435 + - &439 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -23574,7 +23580,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &436 + - &440 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -23590,7 +23596,7 @@ paths: - *17 - *108 - *109 - - &437 + - &441 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -23599,7 +23605,7 @@ paths: required: false schema: type: string - - &438 + - &442 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -23608,7 +23614,7 @@ paths: schema: type: boolean default: false - - &439 + - &443 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -23617,7 +23623,7 @@ paths: schema: type: boolean default: false - - &440 + - &444 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -23633,7 +23639,7 @@ paths: application/json: schema: type: array - items: &441 + items: &445 type: object properties: number: *127 @@ -23649,14 +23655,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &729 + state: &733 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &730 + resolution: &734 type: - string - 'null' @@ -23686,7 +23692,7 @@ paths: type: string description: |- User-friendly name for the detected secret, matching the `secret_type`. - For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." provider: type: - string @@ -23775,14 +23781,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &731 + - &735 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &733 + - &737 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -23846,7 +23852,7 @@ paths: - blob_url - commit_sha - commit_url - - &734 + - &738 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -23907,7 +23913,7 @@ paths: - page_url - commit_sha - commit_url - - &735 + - &739 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -23929,7 +23935,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &736 + - &740 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -23951,7 +23957,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &737 + - &741 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -23973,7 +23979,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &738 + - &742 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -23988,7 +23994,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &739 + - &743 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -24003,7 +24009,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &740 + - &744 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -24018,7 +24024,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &741 + - &745 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -24040,7 +24046,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &742 + - &746 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -24062,7 +24068,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &743 + - &747 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -24084,7 +24090,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &744 + - &748 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -24106,7 +24112,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &745 + - &749 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull @@ -24152,7 +24158,7 @@ paths: - type: 'null' - *4 examples: - default: &442 + default: &446 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -24348,7 +24354,7 @@ paths: operationId: secret-scanning/list-enterprise-pattern-configs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-enterprise-pattern-configurations + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/push-protection#list-enterprise-pattern-configurations x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -24361,7 +24367,7 @@ paths: description: Response content: application/json: - schema: &443 + schema: &447 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. @@ -24448,7 +24454,7 @@ paths: description: Overrides for custom patterns defined by the organization. items: *193 examples: - default: &444 + default: &448 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -24488,7 +24494,7 @@ paths: operationId: secret-scanning/update-enterprise-pattern-configs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-enterprise-pattern-configurations + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/push-protection#update-enterprise-pattern-configurations x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -24581,10 +24587,10 @@ paths: operationId: billing/get-github-advanced-security-billing-ghe externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *39 - - &446 + - &450 name: advanced_security_product in: query description: | @@ -24604,7 +24610,7 @@ paths: description: Success content: application/json: - schema: &447 + schema: &451 type: object properties: total_advanced_security_committers: @@ -24667,7 +24673,7 @@ paths: required: - repositories examples: - default: &448 + default: &452 value: total_advanced_security_committers: 2 total_count: 2 @@ -24708,7 +24714,7 @@ paths: operationId: billing/get-all-budgets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#get-all-budgets + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/budgets#get-all-budgets parameters: - *39 - name: page @@ -24884,7 +24890,7 @@ paths: operationId: billing/create-budget externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#create-a-budget + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/budgets#create-a-budget parameters: - *39 requestBody: @@ -25087,7 +25093,7 @@ paths: operationId: billing/get-budget externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#get-a-budget-by-id + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/budgets#get-a-budget-by-id parameters: - *39 - &195 @@ -25211,7 +25217,7 @@ paths: operationId: billing/update-budget externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#update-a-budget + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/budgets#update-a-budget parameters: - name: enterprise in: path @@ -25438,7 +25444,7 @@ paths: operationId: billing/delete-budget externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#delete-a-budget + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/budgets#delete-a-budget parameters: - *39 - *195 @@ -25483,7 +25489,7 @@ paths: operationId: billing/get-all-cost-centers externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#get-all-cost-centers-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#get-all-cost-centers-for-an-enterprise parameters: - *39 - name: state @@ -25583,7 +25589,7 @@ paths: operationId: billing/create-cost-center externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#create-a-new-cost-center + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#create-a-new-cost-center parameters: - *39 requestBody: @@ -25695,7 +25701,7 @@ paths: operationId: billing/get-cost-center externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#get-a-cost-center-by-id + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#get-a-cost-center-by-id parameters: - *39 - &197 @@ -25784,7 +25790,7 @@ paths: operationId: billing/update-cost-center externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#update-a-cost-center-name + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#update-a-cost-center-name parameters: - name: enterprise in: path @@ -25881,7 +25887,7 @@ paths: operationId: billing/delete-cost-center externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#delete-a-cost-center + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#delete-a-cost-center parameters: - *39 - *197 @@ -25941,7 +25947,7 @@ paths: operationId: billing/add-resource-to-cost-center externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#add-resources-to-a-cost-center + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#add-resources-to-a-cost-center parameters: - *39 - *197 @@ -26034,7 +26040,7 @@ paths: operationId: billing/remove-resource-from-cost-center externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#remove-resources-from-a-cost-center + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/cost-centers#remove-resources-from-a-cost-center parameters: - *39 - *197 @@ -26102,7 +26108,7 @@ paths: operationId: billing/get-github-billing-premium-request-usage-report-ghe externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/usage#get-billing-premium-request-usage-report-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/usage#get-billing-premium-request-usage-report-for-an-enterprise parameters: - *39 - &200 @@ -26310,7 +26316,7 @@ paths: operationId: billing/list-usage-report-exports externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/usage-reports#list-usage-report-exports + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/usage-reports#list-usage-report-exports parameters: - *39 responses: @@ -26440,7 +26446,7 @@ paths: operationId: billing/create-usage-report-export externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/usage-reports#create-a-usage-report-export + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/usage-reports#create-a-usage-report-export parameters: - *39 requestBody: @@ -26526,7 +26532,7 @@ paths: operationId: billing/get-usage-report-export externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/usage-reports#get-a-usage-report-export + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/usage-reports#get-a-usage-report-export parameters: - *39 - name: report_id @@ -26560,13 +26566,13 @@ paths: description: |- Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center. - **Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest//billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform)." + **Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest/billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform)." tags: - billing operationId: billing/get-github-billing-usage-report-ghe externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/usage#get-billing-usage-report-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/usage#get-billing-usage-report-for-an-enterprise parameters: - *39 - *200 @@ -26682,7 +26688,7 @@ paths: operationId: billing/get-github-billing-usage-summary-report-ghe externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/usage#get-billing-usage-summary-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/usage#get-billing-usage-summary-for-an-enterprise parameters: - *39 - *200 @@ -26839,7 +26845,7 @@ paths: summary: Get Copilot metrics for an enterprise team description: |- > [!NOTE] - > This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest//admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." + > This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. @@ -26859,7 +26865,7 @@ paths: operationId: copilot/copilot-metrics-for-enterprise-team externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team parameters: - *39 - *138 @@ -26882,7 +26888,7 @@ paths: - *19 - name: per_page description: The number of days of metrics to display per page (max 100). - For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -26915,7 +26921,7 @@ paths: operationId: enterprise-teams/list externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#list-enterprise-teams + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-teams#list-enterprise-teams parameters: - *39 - *17 @@ -26947,7 +26953,7 @@ paths: operationId: enterprise-teams/create externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#create-an-enterprise-team + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-teams#create-an-enterprise-team parameters: - *39 requestBody: @@ -26980,7 +26986,7 @@ paths: description: | Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. - `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. `all`: The team is assigned to all current and future organizations in the enterprise. enum: - disabled @@ -26992,7 +26998,7 @@ paths: - string - 'null' description: The ID of the IdP group to assign team membership with. - You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/enterprise-cloud@latest//rest/scim#list-provisioned-scim-groups-for-an-enterprise). + You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/enterprise-cloud@latest/rest/scim#list-provisioned-scim-groups-for-an-enterprise). required: - name examples: @@ -27034,7 +27040,7 @@ paths: operationId: enterprise-team-memberships/list externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - *39 - &209 @@ -27092,7 +27098,7 @@ paths: operationId: enterprise-team-memberships/bulk-add externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-add-team-members + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - *39 - *209 @@ -27141,7 +27147,7 @@ paths: operationId: enterprise-team-memberships/bulk-remove externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - *39 - *209 @@ -27190,7 +27196,7 @@ paths: operationId: enterprise-team-memberships/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - *39 - *209 @@ -27235,7 +27241,7 @@ paths: operationId: enterprise-team-memberships/add externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#add-team-member + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - *39 - *209 @@ -27262,7 +27268,7 @@ paths: operationId: enterprise-team-memberships/remove externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#remove-team-membership + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - *39 - *209 @@ -27285,7 +27291,7 @@ paths: operationId: enterprise-team-organizations/get-assignments externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments parameters: - *39 - *209 @@ -27328,7 +27334,7 @@ paths: operationId: enterprise-team-organizations/bulk-add externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments parameters: - *39 - *209 @@ -27389,7 +27395,7 @@ paths: operationId: enterprise-team-organizations/bulk-remove externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments parameters: - *39 - *209 @@ -27430,7 +27436,7 @@ paths: operationId: enterprise-team-organizations/get-assignment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment parameters: - *39 - *209 @@ -27458,7 +27464,7 @@ paths: operationId: enterprise-team-organizations/add externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment parameters: - *39 - *209 @@ -27484,7 +27490,7 @@ paths: operationId: enterprise-team-organizations/delete externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment parameters: - *39 - *209 @@ -27509,7 +27515,7 @@ paths: operationId: enterprise-teams/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#get-an-enterprise-team + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - *39 - &214 @@ -27543,7 +27549,7 @@ paths: operationId: enterprise-teams/update externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#update-an-enterprise-team + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - *39 - *214 @@ -27579,7 +27585,7 @@ paths: description: | Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. - `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). `all`: The team is assigned to all current and future organizations in the enterprise. enum: - disabled @@ -27626,7 +27632,7 @@ paths: operationId: enterprise-teams/delete externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - *39 - *214 @@ -27644,7 +27650,7 @@ paths: summary: Enable or disable a security feature description: |- > [!WARNING] - > **Closing down notice:** The ability to enable or disable a security feature for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + > **Closing down notice:** The ability to enable or disable a security feature for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). Enables or disables the specified security feature for all repositories in an enterprise. @@ -27656,7 +27662,7 @@ paths: operationId: secret-scanning/post-security-product-enablement-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/code-security-and-analysis#enable-or-disable-a-security-feature + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/code-security-and-analysis#enable-or-disable-a-security-feature parameters: - *39 - name: security_product @@ -27711,11 +27717,11 @@ paths: operationId: activity/list-public-events externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-events parameters: - name: per_page description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -27827,7 +27833,7 @@ paths: properties: action: type: string - discussion: &865 + discussion: &870 title: Discussion description: A Discussion in a repository. type: object @@ -28328,7 +28334,7 @@ paths: milestone: anyOf: - type: 'null' - - &410 + - &414 title: Milestone description: A collection of related issues and pull requests. @@ -28500,7 +28506,7 @@ paths: timeline_url: type: string format: uri - type: &376 + type: &380 title: Issue Type description: The type of issue. type: @@ -28611,7 +28617,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &788 + sub_issues_summary: &792 title: Sub-issues Summary type: object properties: @@ -28695,7 +28701,7 @@ paths: pin: anyOf: - type: 'null' - - &674 + - &678 title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. @@ -28722,7 +28728,7 @@ paths: - url - created_at - updated_at - issue_dependencies_summary: &789 + issue_dependencies_summary: &793 title: Issue Dependencies Summary type: object properties: @@ -28741,7 +28747,7 @@ paths: - total_blocking issue_field_values: type: array - items: &658 + items: &662 title: Issue Field Value description: A value assigned to an issue field type: object @@ -29522,7 +29528,7 @@ paths: type: string release: allOf: - - &708 + - &712 title: Release description: A release. type: object @@ -29604,7 +29610,7 @@ paths: author: *4 assets: type: array - items: &709 + items: &713 title: Release Asset description: Data related to a release. type: object @@ -29785,23 +29791,23 @@ paths: Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. * **Timeline**: The GitHub Enterprise Cloud global public timeline - * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." * **Current user public**: The public timeline for the authenticated user * **Current user**: The private timeline for the authenticated user * **Current user actor**: The private timeline for activity created by the authenticated user * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud. - By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." > [!NOTE] - > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. + > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. tags: - activity operationId: activity/get-feeds externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/feeds#get-feeds + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/feeds#get-feeds parameters: [] responses: '200': @@ -29944,7 +29950,7 @@ paths: operationId: gists/list externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-gists-for-the-authenticated-user parameters: - *224 - *17 @@ -30118,7 +30124,7 @@ paths: - gists externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#create-a-gist + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#create-a-gist parameters: [] requestBody: required: true @@ -30195,7 +30201,7 @@ paths: url: type: string format: uri - user: &795 + user: &799 title: Public User description: Public User type: object @@ -30665,13 +30671,13 @@ paths: description: |- List public gists sorted by most recently updated to least recently updated. - Note: With [pagination](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + Note: With [pagination](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. tags: - gists operationId: gists/list-public externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-public-gists parameters: - *224 - *17 @@ -30705,7 +30711,7 @@ paths: operationId: gists/list-starred externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-starred-gists parameters: - *224 - *17 @@ -30736,7 +30742,7 @@ paths: description: |- Gets a specified gist. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. tags: @@ -30744,7 +30750,7 @@ paths: operationId: gists/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#get-a-gist parameters: - &229 name: gist_id @@ -30799,7 +30805,7 @@ paths: At least one of `description` or `files` is required. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. tags: @@ -30807,7 +30813,7 @@ paths: operationId: gists/update externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#update-a-gist parameters: - *229 requestBody: @@ -31031,7 +31037,7 @@ paths: operationId: gists/delete externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#delete-a-gist parameters: - *229 responses: @@ -31051,7 +31057,7 @@ paths: description: |- Lists the comments on a gist. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. tags: @@ -31059,7 +31065,7 @@ paths: operationId: gists/list-comments externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/comments#list-gist-comments parameters: - *229 - *17 @@ -31163,7 +31169,7 @@ paths: description: |- Creates a comment on a gist. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. tags: @@ -31171,7 +31177,7 @@ paths: operationId: gists/create-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/comments#create-a-gist-comment parameters: - *229 requestBody: @@ -31248,7 +31254,7 @@ paths: description: |- Gets a comment on a gist. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. tags: @@ -31256,7 +31262,7 @@ paths: operationId: gists/get-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/comments#get-a-gist-comment parameters: - *229 - &233 @@ -31288,7 +31294,7 @@ paths: description: |- Updates a comment on a gist. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. tags: @@ -31296,7 +31302,7 @@ paths: operationId: gists/update-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/comments#update-a-gist-comment parameters: - *229 - *233 @@ -31342,7 +31348,7 @@ paths: operationId: gists/delete-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/comments#delete-a-gist-comment parameters: - *229 - *233 @@ -31366,7 +31372,7 @@ paths: operationId: gists/list-commits externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-gist-commits parameters: - *229 - *17 @@ -31467,7 +31473,7 @@ paths: operationId: gists/list-forks externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-gist-forks parameters: - *229 - *17 @@ -31542,7 +31548,7 @@ paths: operationId: gists/fork externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#fork-a-gist parameters: - *229 responses: @@ -31619,7 +31625,7 @@ paths: operationId: gists/check-is-starred externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#check-if-a-gist-is-starred parameters: - *229 responses: @@ -31643,13 +31649,13 @@ paths: put: summary: Star a gist description: Note that you'll need to set `Content-Length` to zero when calling - out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - gists operationId: gists/star externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#star-a-gist parameters: - *229 responses: @@ -31671,7 +31677,7 @@ paths: operationId: gists/unstar externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#unstar-a-gist parameters: - *229 responses: @@ -31691,7 +31697,7 @@ paths: description: |- Gets a specified gist revision. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. tags: @@ -31699,7 +31705,7 @@ paths: operationId: gists/get-revision externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#get-a-gist-revision parameters: - *229 - name: sha @@ -31727,13 +31733,13 @@ paths: get: summary: Get all gitignore templates description: List all templates available to pass as an option when [creating - a repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-for-the-authenticated-user). + a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-for-the-authenticated-user). operationId: gitignore/get-all-templates tags: - gitignore externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gitignore/gitignore#get-all-gitignore-templates + url: https://docs.github.com/enterprise-cloud@latest/rest/gitignore/gitignore#get-all-gitignore-templates parameters: [] responses: '200': @@ -31766,7 +31772,7 @@ paths: description: |- Get the content of a gitignore template. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. operationId: gitignore/get-template @@ -31774,7 +31780,7 @@ paths: - gitignore externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gitignore/gitignore#get-a-gitignore-template + url: https://docs.github.com/enterprise-cloud@latest/rest/gitignore/gitignore#get-a-gitignore-template parameters: - name: name in: path @@ -31856,7 +31862,7 @@ paths: operationId: apps/list-repos-accessible-to-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#list-repositories-accessible-to-the-app-installation + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#list-repositories-accessible-to-the-app-installation parameters: - *17 - *19 @@ -32016,13 +32022,13 @@ paths: description: |- Revokes the installation token you're using to authenticate as an installation and access this endpoint. - Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. + Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. tags: - apps operationId: apps/revoke-installation-access-token externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#revoke-an-installation-access-token + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#revoke-an-installation-access-token parameters: [] responses: '204': @@ -32041,9 +32047,9 @@ paths: necessarily assigned to you. > [!NOTE] - > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests)" endpoint. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -32054,7 +32060,7 @@ paths: operationId: issues/list externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-issues-assigned-to-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-issues-assigned-to-the-authenticated-user parameters: - name: filter description: Indicates which sorts of issues to return. `assigned` means issues @@ -32085,7 +32091,7 @@ paths: - closed - all default: open - - &379 + - &383 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -32136,7 +32142,7 @@ paths: type: array items: *219 examples: - default: &380 + default: &384 value: - id: 1 node_id: MDU6SXNzdWUx @@ -32394,13 +32400,13 @@ paths: get: summary: Get all commonly used licenses description: Lists the most commonly used licenses on GitHub. For more information, - see "[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + see "[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." tags: - licenses operationId: licenses/get-all-commonly-used externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-all-commonly-used-licenses + url: https://docs.github.com/enterprise-cloud@latest/rest/licenses/licenses#get-all-commonly-used-licenses parameters: - name: featured in: query @@ -32465,13 +32471,13 @@ paths: get: summary: Get a license description: Gets information about a specific license. For more information, - see "[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + see "[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." tags: - licenses operationId: licenses/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-a-license + url: https://docs.github.com/enterprise-cloud@latest/rest/licenses/licenses#get-a-license parameters: - name: license in: path @@ -32668,7 +32674,7 @@ paths: - markdown externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/markdown/markdown#render-a-markdown-document + url: https://docs.github.com/enterprise-cloud@latest/rest/markdown/markdown#render-a-markdown-document parameters: [] requestBody: required: true @@ -32745,7 +32751,7 @@ paths: - markdown externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/markdown/markdown#render-a-markdown-document-in-raw-mode + url: https://docs.github.com/enterprise-cloud@latest/rest/markdown/markdown#render-a-markdown-document-in-raw-mode parameters: [] requestBody: required: false @@ -32790,13 +32796,13 @@ paths: description: |- Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. tags: - apps operationId: apps/get-subscription-plan-for-account externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - &237 name: account_id @@ -33023,13 +33029,13 @@ paths: description: |- Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing. - GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. tags: - apps operationId: apps/list-plans externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-plans + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-plans parameters: - *17 - *19 @@ -33074,13 +33080,13 @@ paths: description: |- Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. tags: - apps operationId: apps/list-accounts-for-plan externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-accounts-for-a-plan parameters: - &240 name: plan_id @@ -33187,13 +33193,13 @@ paths: description: |- Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. tags: - apps operationId: apps/get-subscription-plan-for-account-stubbed externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - *237 responses: @@ -33218,13 +33224,13 @@ paths: description: |- Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing. - GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. tags: - apps operationId: apps/list-plans-stubbed externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-plans-stubbed + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-plans-stubbed parameters: - *17 - *19 @@ -33252,13 +33258,13 @@ paths: description: |- Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. tags: - apps operationId: apps/list-accounts-for-plan-stubbed externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - *240 - *241 @@ -33296,7 +33302,7 @@ paths: get: summary: Get GitHub Enterprise Cloud meta information description: |- - Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/enterprise-cloud@latest//articles/about-github-s-ip-addresses/)." + Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/enterprise-cloud@latest/articles/about-github-s-ip-addresses/)." The API's response also includes a list of GitHub's domain names. @@ -33309,7 +33315,7 @@ paths: operationId: meta/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#get-apiname-meta-information + url: https://docs.github.com/enterprise-cloud@latest/rest/meta/meta#get-apiname-meta-information parameters: [] responses: '200': @@ -33546,16 +33552,16 @@ paths: operationId: activity/list-public-events-for-repo-network externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &461 + - &465 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &462 + - &466 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -33617,7 +33623,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &467 + '301': &471 description: Moved permanently content: application/json: @@ -33637,9 +33643,9 @@ paths: operationId: activity/list-notifications-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &682 + - &686 name: all description: If `true`, show notifications marked as read. in: query @@ -33647,7 +33653,7 @@ paths: schema: type: boolean default: false - - &683 + - &687 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -33657,7 +33663,7 @@ paths: type: boolean default: false - *224 - - &684 + - &688 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -33670,7 +33676,7 @@ paths: - *19 - name: per_page description: The number of results per page (max 50). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -34039,7 +34045,7 @@ paths: type: boolean examples: - false - security_and_analysis: &421 + security_and_analysis: &425 type: - object - 'null' @@ -34258,7 +34264,7 @@ paths: - url - subscription_url examples: - default: &685 + default: &689 value: - id: '1' repository: @@ -34356,14 +34362,14 @@ paths: number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications - remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user) + remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. tags: - activity operationId: activity/mark-notifications-as-read externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-notifications-as-read + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-notifications-as-read parameters: [] requestBody: required: false @@ -34422,13 +34428,13 @@ paths: operationId: activity/get-thread externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#get-a-thread parameters: - &245 name: thread_id description: The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications - (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user)). + (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user)). in: path required: true schema: @@ -34539,7 +34545,7 @@ paths: operationId: activity/mark-thread-as-read externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-a-thread-as-read parameters: - *245 responses: @@ -34562,7 +34568,7 @@ paths: operationId: activity/mark-thread-as-done externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-a-thread-as-done parameters: - *245 responses: @@ -34577,7 +34583,7 @@ paths: get: summary: Get a thread subscription for the authenticated user description: |- - This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription). + This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#get-a-repository-subscription). Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. tags: @@ -34585,7 +34591,7 @@ paths: operationId: activity/get-thread-subscription-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - *245 responses: @@ -34660,13 +34666,13 @@ paths: You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. - Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription) endpoint. + Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#delete-a-thread-subscription) endpoint. tags: - activity operationId: activity/set-thread-subscription externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#set-a-thread-subscription parameters: - *245 requestBody: @@ -34705,14 +34711,14 @@ paths: description: Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications - for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription) + for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. tags: - activity operationId: activity/delete-thread-subscription externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#delete-a-thread-subscription parameters: - *245 responses: @@ -34773,7 +34779,7 @@ paths: :~==~==~==~==~~ externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#get-octocat + url: https://docs.github.com/enterprise-cloud@latest/rest/meta/meta#get-octocat x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34786,13 +34792,13 @@ paths: Lists all organizations, in the order that they were created. > [!NOTE] - > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. tags: - orgs operationId: orgs/list externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-organizations parameters: - name: since description: An organization ID. Only return organizations with an ID greater @@ -34828,9 +34834,9 @@ paths: summary: Closing down - List custom repository roles in an organization description: |- > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed in the future. Use the "[List custom repository roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. + > **Closing down notice:** This operation is closing down and will be removed in the future. Use the "[List custom repository roles](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. - List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint. @@ -34840,7 +34846,7 @@ paths: operationId: orgs/list-custom-roles externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-custom-repository-roles-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---list-custom-repository-roles-in-an-organization parameters: - name: organization_id description: The unique identifier of the organization. @@ -34863,7 +34869,7 @@ paths: - 3 custom_roles: type: array - items: &324 + items: &328 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -34912,7 +34918,7 @@ paths: - created_at - updated_at examples: - default: &325 + default: &329 value: id: 8030 name: Security Engineer @@ -34957,7 +34963,7 @@ paths: operationId: actions/get-actions-cache-retention-limit-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization parameters: - *87 responses: @@ -34997,7 +35003,7 @@ paths: operationId: actions/set-actions-cache-retention-limit-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization parameters: - *87 requestBody: @@ -35031,7 +35037,7 @@ paths: operationId: actions/get-actions-cache-storage-limit-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization parameters: - *87 responses: @@ -35071,7 +35077,7 @@ paths: operationId: actions/set-actions-cache-storage-limit-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization parameters: - *87 requestBody: @@ -35109,7 +35115,7 @@ paths: operationId: orgs/custom-properties-for-orgs-get-organization-values externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization parameters: - *87 responses: @@ -35121,7 +35127,7 @@ paths: type: array items: *152 examples: - default: &691 + default: &695 value: - property_name: environment value: production @@ -35153,7 +35159,7 @@ paths: operationId: orgs/custom-properties-for-orgs-create-or-update-organization-values externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization parameters: - *87 requestBody: @@ -35171,7 +35177,7 @@ paths: required: - properties examples: - default: &692 + default: &696 value: properties: - property_name: environment @@ -35198,7 +35204,7 @@ paths: description: |- Gets information about an organization. - When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/enterprise-cloud@latest//articles/securing-your-account-with-two-factor-authentication-2fa/). + When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/enterprise-cloud@latest/articles/securing-your-account-with-two-factor-authentication-2fa/). To see the full details about an organization, the authenticated user must be an organization owner. @@ -35210,7 +35216,7 @@ paths: operationId: orgs/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#get-an-organization parameters: - *87 responses: @@ -35498,7 +35504,7 @@ paths: advanced_security_enabled_for_new_repositories: type: boolean description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. @@ -35509,7 +35515,7 @@ paths: dependabot_alerts_enabled_for_new_repositories: type: boolean description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. @@ -35520,7 +35526,7 @@ paths: dependabot_security_updates_enabled_for_new_repositories: type: boolean description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. @@ -35531,7 +35537,7 @@ paths: dependency_graph_enabled_for_new_repositories: type: boolean description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. @@ -35542,7 +35548,7 @@ paths: secret_scanning_enabled_for_new_repositories: type: boolean description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. @@ -35553,7 +35559,7 @@ paths: secret_scanning_push_protection_enabled_for_new_repositories: type: boolean description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. @@ -35578,7 +35584,7 @@ paths: secret_scanning_validity_checks_enabled: type: boolean description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization. examples: @@ -35716,7 +35722,7 @@ paths: > **Closing down notice:** GitHub Enterprise Cloud will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). > [!WARNING] - > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). + > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). Updates the organization's profile and member privileges. @@ -35728,7 +35734,7 @@ paths: operationId: orgs/update externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#update-an-organization parameters: - *87 requestBody: @@ -35791,20 +35797,20 @@ paths: members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, - see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" + see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. members_can_create_private_repositories: type: boolean description: Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "[Restricting repository creation in your - organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" + organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. members_can_create_public_repositories: type: boolean description: Whether organization members can create public repositories, which are visible to anyone. For more information, see "[Restricting - repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" + repository creation in your organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. members_allowed_repository_creation_type: type: string @@ -35853,66 +35859,66 @@ paths: advanced_security_enabled_for_new_repositories: type: boolean description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. deprecated: true dependabot_alerts_enabled_for_new_repositories: type: boolean description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. deprecated: true dependabot_security_updates_enabled_for_new_repositories: type: boolean description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. deprecated: true dependency_graph_enabled_for_new_repositories: type: boolean description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. deprecated: true secret_scanning_enabled_for_new_repositories: type: boolean description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. deprecated: true secret_scanning_push_protection_enabled_for_new_repositories: type: boolean description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. deprecated: true @@ -35928,7 +35934,7 @@ paths: secret_scanning_validity_checks_enabled: type: boolean description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization. deprecated: true @@ -35980,13 +35986,13 @@ paths: Please review the Terms of Service regarding account deletion before using this endpoint: - https://docs.github.com/enterprise-cloud@latest//site-policy/github-terms/github-terms-of-service + https://docs.github.com/enterprise-cloud@latest/site-policy/github-terms/github-terms-of-service operationId: orgs/delete tags: - orgs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#delete-an-organization parameters: - *87 responses: @@ -36011,7 +36017,7 @@ paths: operationId: actions/get-actions-cache-usage-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - *87 responses: @@ -36042,7 +36048,7 @@ paths: operationId: actions/get-actions-cache-usage-by-repo-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization parameters: - *87 - *17 @@ -36062,7 +36068,7 @@ paths: type: integer repository_cache_usages: type: array - items: &474 + items: &478 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -36118,7 +36124,7 @@ paths: operationId: actions/list-hosted-runners-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - *87 - *17 @@ -36158,7 +36164,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization parameters: - *87 requestBody: @@ -36258,7 +36264,7 @@ paths: operationId: actions/list-custom-images-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-custom-images-for-an-organization parameters: - *87 responses: @@ -36296,7 +36302,7 @@ paths: operationId: actions/get-custom-image-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners parameters: - *87 - *48 @@ -36324,7 +36330,7 @@ paths: operationId: actions/delete-custom-image-from-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization parameters: - *87 - *48 @@ -36348,7 +36354,7 @@ paths: operationId: actions/list-custom-image-versions-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization parameters: - *48 - *87 @@ -36387,7 +36393,7 @@ paths: operationId: actions/get-custom-image-version-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners parameters: - *87 - *48 @@ -36416,7 +36422,7 @@ paths: operationId: actions/delete-custom-image-version-from-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization parameters: - *87 - *48 @@ -36439,7 +36445,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization parameters: - *87 responses: @@ -36475,7 +36481,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization parameters: - *87 responses: @@ -36510,7 +36516,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization parameters: - *87 responses: @@ -36536,7 +36542,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization parameters: - *87 responses: @@ -36572,7 +36578,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization parameters: - *87 responses: @@ -36616,7 +36622,7 @@ paths: operationId: actions/get-hosted-runner-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - *87 - *56 @@ -36645,7 +36651,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - *87 - *56 @@ -36731,7 +36737,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - *87 - *56 @@ -36760,7 +36766,7 @@ paths: operationId: oidc/list-oidc-custom-property-inclusions-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-organization parameters: - *87 responses: @@ -36793,7 +36799,7 @@ paths: operationId: oidc/create-oidc-custom-property-inclusion-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-organization parameters: - *87 requestBody: @@ -36832,7 +36838,7 @@ paths: operationId: oidc/delete-oidc-custom-property-inclusion-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-organization parameters: - *87 - name: custom_property_name @@ -36865,7 +36871,7 @@ paths: operationId: oidc/get-oidc-custom-sub-template-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - *87 responses: @@ -36884,6 +36890,12 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the + name-based format. + type: boolean required: - include_claim_keys examples: @@ -36907,7 +36919,7 @@ paths: operationId: oidc/update-oidc-custom-sub-template-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - *87 requestBody: @@ -36925,6 +36937,12 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for the organization. When `true`, new OIDC tokens will + use a stable, repository-ID-based `sub` claim instead of the name-based + format. + type: boolean examples: default: *264 responses: @@ -36960,7 +36978,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - *87 responses: @@ -37014,7 +37032,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - *87 responses: @@ -37055,7 +37073,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization parameters: - *87 responses: @@ -37087,7 +37105,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization parameters: - *87 requestBody: @@ -37122,7 +37140,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization parameters: - *87 responses: @@ -37149,7 +37167,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization parameters: - *87 responses: @@ -37181,7 +37199,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - *87 responses: @@ -37207,7 +37225,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - *87 requestBody: @@ -37244,7 +37262,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - *87 - *17 @@ -37404,7 +37422,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - *87 responses: @@ -37448,7 +37466,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - *87 - &272 @@ -37477,7 +37495,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - *87 - *272 @@ -37501,7 +37519,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - *87 responses: @@ -37532,7 +37550,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - *87 responses: @@ -37562,7 +37580,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization parameters: - *87 responses: @@ -37610,7 +37628,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization parameters: - *87 requestBody: @@ -37657,7 +37675,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - *87 - *17 @@ -37694,7 +37712,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - *87 requestBody: @@ -37742,7 +37760,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - *87 - *272 @@ -37769,7 +37787,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - *87 - *272 @@ -37790,7 +37808,7 @@ paths: description: |- Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -37798,7 +37816,7 @@ paths: operationId: actions/get-github-actions-default-workflow-permissions-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - *87 responses: @@ -37819,7 +37837,7 @@ paths: description: |- Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions can submit approving pull request reviews. For more information, see - "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -37827,7 +37845,7 @@ paths: operationId: actions/set-github-actions-default-workflow-permissions-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - *87 responses: @@ -37860,7 +37878,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - *87 - *17 @@ -38002,7 +38020,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - *87 requestBody: @@ -38112,7 +38130,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - *87 - *72 @@ -38155,7 +38173,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - *87 - *72 @@ -38233,7 +38251,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - *87 - *72 @@ -38257,7 +38275,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - *87 - *72 @@ -38300,7 +38318,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *87 - *72 @@ -38323,7 +38341,7 @@ paths: type: array items: *278 examples: - default: &322 + default: &326 value: total_count: 1 repositories: @@ -38573,7 +38591,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - *87 - *72 @@ -38618,7 +38636,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *87 - *72 @@ -38642,7 +38660,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *87 - *72 @@ -38667,7 +38685,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - *87 - *72 @@ -38709,7 +38727,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - *87 - *72 @@ -38754,7 +38772,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - *87 - *72 @@ -38778,7 +38796,7 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - *87 - *72 @@ -38805,7 +38823,7 @@ paths: operationId: actions/list-self-hosted-runners-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization parameters: - name: name description: The name of a self-hosted runner. @@ -38854,7 +38872,7 @@ paths: operationId: actions/list-runner-applications-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - *87 responses: @@ -38886,7 +38904,7 @@ paths: operationId: actions/generate-runner-jitconfig-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - *87 requestBody: @@ -38960,7 +38978,7 @@ paths: operationId: actions/create-registration-token-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - *87 responses: @@ -38996,7 +39014,7 @@ paths: operationId: actions/create-remove-token-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - *87 responses: @@ -39026,7 +39044,7 @@ paths: operationId: actions/get-self-hosted-runner-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - *87 - *75 @@ -39056,7 +39074,7 @@ paths: operationId: actions/delete-self-hosted-runner-from-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - *87 - *75 @@ -39083,7 +39101,7 @@ paths: operationId: actions/list-labels-for-self-hosted-runner-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - *87 - *75 @@ -39108,7 +39126,7 @@ paths: operationId: actions/add-custom-labels-to-self-hosted-runner-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - *87 - *75 @@ -39157,7 +39175,7 @@ paths: operationId: actions/set-custom-labels-for-self-hosted-runner-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - *87 - *75 @@ -39207,7 +39225,7 @@ paths: operationId: actions/remove-all-custom-labels-from-self-hosted-runner-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - *87 - *75 @@ -39237,7 +39255,7 @@ paths: operationId: actions/remove-custom-label-from-self-hosted-runner-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - *87 - *75 @@ -39266,7 +39284,7 @@ paths: operationId: actions/list-org-secrets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-organization-secrets parameters: - *87 - *17 @@ -39359,7 +39377,7 @@ paths: operationId: actions/get-org-public-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-organization-public-key parameters: - *87 responses: @@ -39367,7 +39385,7 @@ paths: description: Response content: application/json: - schema: &494 + schema: &498 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -39402,7 +39420,7 @@ paths: - key_id - key examples: - default: &495 + default: &499 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -39425,7 +39443,7 @@ paths: operationId: actions/get-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-organization-secret parameters: - *87 - &288 @@ -39458,7 +39476,7 @@ paths: summary: Create or update an organization secret description: |- Creates or updates an organization secret with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." Authenticated users must have collaborator access to a repository to create, update, or read secrets. @@ -39468,7 +39486,7 @@ paths: operationId: actions/create-or-update-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-organization-secret parameters: - *87 - *288 @@ -39483,7 +39501,7 @@ paths: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public - key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key) + key](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-organization-public-key) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: @@ -39504,9 +39522,9 @@ paths: secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for - an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret), - [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret), - and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret) + an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), + [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. items: type: integer @@ -39552,7 +39570,7 @@ paths: operationId: actions/delete-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-an-organization-secret parameters: - *87 - *288 @@ -39579,7 +39597,7 @@ paths: operationId: actions/list-selected-repos-for-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - *87 - *288 @@ -39682,7 +39700,7 @@ paths: description: |- Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create - or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret). + or update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-organization-secret). Authenticated users must have collaborator access to a repository to create, update, or read secrets. @@ -39692,7 +39710,7 @@ paths: operationId: actions/set-selected-repos-for-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - *87 - *288 @@ -39709,8 +39727,8 @@ paths: secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization - secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret) - and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret) + secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#add-selected-repository-to-an-organization-secret) + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. items: type: integer @@ -39735,7 +39753,7 @@ paths: description: |- Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. For more information about setting the visibility, see [Create or - update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret). + update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-organization-secret). Authenticated users must have collaborator access to a repository to create, update, or read secrets. @@ -39745,7 +39763,7 @@ paths: operationId: actions/add-selected-repo-to-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - *87 - *288 @@ -39769,7 +39787,7 @@ paths: description: |- Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create - or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret). + or update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-organization-secret). Authenticated users must have collaborator access to a repository to create, update, or read secrets. @@ -39779,7 +39797,7 @@ paths: operationId: actions/remove-selected-repo-from-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - *87 - *288 @@ -39812,13 +39830,13 @@ paths: operationId: actions/list-org-variables externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-organization-variables parameters: - *87 - - &479 + - &483 name: per_page description: The number of results per page (max 30). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -39927,7 +39945,7 @@ paths: operationId: actions/create-org-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-an-organization-variable parameters: - *87 requestBody: @@ -40000,7 +40018,7 @@ paths: operationId: actions/get-org-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-an-organization-variable parameters: - *87 - &291 @@ -40043,7 +40061,7 @@ paths: operationId: actions/update-org-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-an-organization-variable parameters: - *87 - *291 @@ -40106,7 +40124,7 @@ paths: operationId: actions/delete-org-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-an-organization-variable parameters: - *87 - *291 @@ -40133,7 +40151,7 @@ paths: operationId: actions/list-selected-repos-for-org-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - *87 - *291 @@ -40180,7 +40198,7 @@ paths: operationId: actions/set-selected-repos-for-org-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - *87 - *291 @@ -40230,7 +40248,7 @@ paths: operationId: actions/add-selected-repo-to-org-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - *87 - *291 @@ -40265,7 +40283,7 @@ paths: operationId: actions/remove-selected-repo-from-org-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - *87 - *291 @@ -40297,7 +40315,7 @@ paths: operationId: announcement-banners/get-announcement-banner-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/organizations#get-announcement-banner-for-organization parameters: - *87 responses: @@ -40321,7 +40339,7 @@ paths: operationId: announcement-banners/set-announcement-banner-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#set-announcement-banner-for-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/organizations#set-announcement-banner-for-organization requestBody: required: true content: @@ -40352,7 +40370,7 @@ paths: operationId: announcement-banners/remove-announcement-banner-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/announcement-banners/organizations#remove-announcement-banner-from-organization parameters: - *87 responses: @@ -40385,7 +40403,7 @@ paths: operationId: orgs/create-artifact-deployment-record externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#create-an-artifact-deployment-record + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/artifact-metadata#create-an-artifact-deployment-record parameters: - *87 requestBody: @@ -40595,7 +40613,7 @@ paths: operationId: orgs/set-cluster-deployment-records externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#set-cluster-deployment-records + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/artifact-metadata#set-cluster-deployment-records parameters: - *87 - name: cluster @@ -40791,7 +40809,7 @@ paths: operationId: orgs/create-artifact-storage-record externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#create-artifact-metadata-storage-record + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record parameters: - *87 requestBody: @@ -40966,7 +40984,7 @@ paths: operationId: orgs/list-artifact-deployment-records externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#list-artifact-deployment-records + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/artifact-metadata#list-artifact-deployment-records parameters: - *87 - name: subject_digest @@ -41014,7 +41032,7 @@ paths: operationId: orgs/list-artifact-storage-records externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#list-artifact-storage-records + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/artifact-metadata#list-artifact-storage-records parameters: - *87 - name: subject_digest @@ -41091,13 +41109,13 @@ paths: The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. - **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). tags: - orgs operationId: orgs/list-attestations-bulk externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations-by-bulk-subject-digests + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - *108 @@ -41126,12 +41144,12 @@ paths: required: - subject_digests examples: - default: &826 + default: &830 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &827 + withPredicateType: &831 value: subject_digests: - sha256:abc123 @@ -41190,7 +41208,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &828 + default: &832 value: attestations_subject_digests: - sha256:abc: @@ -41297,7 +41315,7 @@ paths: operationId: orgs/delete-attestations-bulk externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-in-bulk + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#delete-attestations-in-bulk parameters: - *87 requestBody: @@ -41362,7 +41380,7 @@ paths: operationId: orgs/delete-attestations-by-subject-digest externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-subject-digest + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - *87 - name: subject_digest @@ -41394,7 +41412,7 @@ paths: operationId: orgs/list-attestation-repositories externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestation-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#list-attestation-repositories parameters: - *17 - *108 @@ -41445,7 +41463,7 @@ paths: operationId: orgs/delete-attestations-by-id externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-id + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#delete-attestations-by-id parameters: - *87 - name: attestation_id @@ -41474,13 +41492,13 @@ paths: The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. - **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). tags: - orgs operationId: orgs/list-attestations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/attestations#list-attestations parameters: - *17 - *108 @@ -41541,7 +41559,7 @@ paths: initiator: type: string examples: - default: &508 + default: &512 value: attestations: - bundle: @@ -41641,13 +41659,13 @@ paths: get: summary: Get the audit log for an organization description: |- - Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." + Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." - By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." + By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." - Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api)." + Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api)." - This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators)." + This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-integrators)." The authenticated user must be an organization owner to use this endpoint. @@ -41657,12 +41675,12 @@ paths: - orgs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-the-audit-log-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#get-the-audit-log-for-an-organization parameters: - *87 - name: phrase description: A search phrase. For more information, see [Searching the audit - log](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). + log](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). in: query required: false schema: @@ -41696,7 +41714,7 @@ paths: operationId: orgs/list-blocked-users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - *87 - *17 @@ -41727,7 +41745,7 @@ paths: operationId: orgs/check-blocked-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - *87 - *140 @@ -41753,7 +41771,7 @@ paths: operationId: orgs/block-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking#block-a-user-from-an-organization parameters: - *87 - *140 @@ -41774,7 +41792,7 @@ paths: operationId: orgs/unblock-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - *87 - *140 @@ -41796,7 +41814,7 @@ paths: operationId: orgs/list-push-bypass-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/bypass-requests#list-push-rule-bypass-requests-within-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/bypass-requests#list-push-rule-bypass-requests-within-an-organization x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -41841,7 +41859,7 @@ paths: operationId: secret-scanning/list-org-bypass-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-org + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-org x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -41882,7 +41900,7 @@ paths: operationId: campaigns/list-org-campaigns externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#list-campaigns-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - *87 - *19 @@ -42088,7 +42106,7 @@ paths: operationId: campaigns/create-campaign externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#create-a-campaign-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - *87 requestBody: @@ -42262,7 +42280,7 @@ paths: operationId: campaigns/get-campaign-summary externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#get-a-campaign-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - *87 - name: campaign_number @@ -42304,7 +42322,7 @@ paths: operationId: campaigns/update-campaign externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#update-a-campaign + url: https://docs.github.com/enterprise-cloud@latest/rest/campaigns/campaigns#update-a-campaign parameters: - *87 - name: campaign_number @@ -42399,7 +42417,7 @@ paths: operationId: campaigns/delete-campaign externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#delete-a-campaign-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - *87 - name: campaign_number @@ -42422,7 +42440,7 @@ paths: get: summary: List code scanning alerts for an organization description: |- - Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." The authenticated user must be an owner or security manager for the organization to use this endpoint. @@ -42432,7 +42450,7 @@ paths: operationId: code-scanning/list-alerts-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *87 - *311 @@ -42463,7 +42481,7 @@ paths: be returned. in: query required: false - schema: &533 + schema: &537 type: string description: Severity of a code scanning alert. enum: @@ -42515,7 +42533,7 @@ paths: operationId: code-security/get-configurations-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - *87 - name: target_type @@ -42531,7 +42549,7 @@ paths: - name: per_page in: query description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." required: false schema: type: integer @@ -42621,7 +42639,7 @@ paths: operationId: code-security/create-configuration externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#create-a-code-security-configuration parameters: - *87 requestBody: @@ -42887,7 +42905,7 @@ paths: operationId: code-security/get-default-configurations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-default-code-security-configurations parameters: - *87 responses: @@ -42921,7 +42939,7 @@ paths: operationId: code-security/detach-configuration externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#detach-configurations-from-repositories parameters: - *87 requestBody: @@ -42975,7 +42993,7 @@ paths: operationId: code-security/get-configuration externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-a-code-security-configuration parameters: - *87 - *116 @@ -43008,7 +43026,7 @@ paths: operationId: code-security/update-configuration externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#update-a-code-security-configuration parameters: - *87 - *116 @@ -43288,7 +43306,7 @@ paths: operationId: code-security/delete-configuration externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#delete-a-code-security-configuration parameters: - *87 - *116 @@ -43319,7 +43337,7 @@ paths: operationId: code-security/attach-configuration externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - *87 - *116 @@ -43383,7 +43401,7 @@ paths: operationId: code-security/set-configuration-as-default externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - *87 - *116 @@ -43453,13 +43471,13 @@ paths: operationId: code-security/get-repositories-for-configuration externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - *87 - *116 - name: per_page description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: @@ -43510,7 +43528,7 @@ paths: operationId: codespaces/list-in-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#list-codespaces-for-the-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#list-codespaces-for-the-organization parameters: - *17 - *19 @@ -43530,7 +43548,7 @@ paths: type: integer codespaces: type: array - items: &381 + items: &385 type: object title: Codespace description: A codespace. @@ -43565,7 +43583,7 @@ paths: machine: anyOf: - type: 'null' - - &565 + - &569 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -43852,7 +43870,7 @@ paths: - pulls_url - recent_folders examples: - default: &382 + default: &386 value: total_count: 3 codespaces: @@ -44282,7 +44300,7 @@ paths: operationId: codespaces/set-codespaces-access externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - *87 deprecated: true @@ -44341,7 +44359,7 @@ paths: Codespaces for the specified users will be billed to the organization. To use this endpoint, the access settings for the organization must be set to `selected_members`. - For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." + For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -44349,7 +44367,7 @@ paths: operationId: codespaces/set-codespaces-access-users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - *87 deprecated: true @@ -44395,7 +44413,7 @@ paths: Codespaces for the specified users will no longer be billed to the organization. To use this endpoint, the access settings for the organization must be set to `selected_members`. - For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." + For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -44403,7 +44421,7 @@ paths: operationId: codespaces/delete-codespaces-access-users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - *87 @@ -44456,7 +44474,7 @@ paths: operationId: codespaces/list-org-secrets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#list-organization-secrets parameters: - *87 - *17 @@ -44517,7 +44535,7 @@ paths: - updated_at - visibility examples: - default: &566 + default: &570 value: total_count: 2 secrets: @@ -44547,7 +44565,7 @@ paths: operationId: codespaces/get-org-public-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - *87 responses: @@ -44555,7 +44573,7 @@ paths: description: Response content: application/json: - schema: &567 + schema: &571 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -44590,7 +44608,7 @@ paths: - key_id - key examples: - default: &568 + default: &572 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -44611,7 +44629,7 @@ paths: operationId: codespaces/get-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - *87 - *288 @@ -44622,7 +44640,7 @@ paths: application/json: schema: *321 examples: - default: &570 + default: &574 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -44639,7 +44657,7 @@ paths: summary: Create or update an organization secret description: |- Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -44647,7 +44665,7 @@ paths: operationId: codespaces/create-or-update-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - *87 - *288 @@ -44662,7 +44680,7 @@ paths: type: string description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public - key](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key) + key](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: @@ -44683,9 +44701,9 @@ paths: secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for - an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), - [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), - and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) + an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), + [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. items: type: integer @@ -44729,7 +44747,7 @@ paths: operationId: codespaces/delete-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - *87 - *288 @@ -44755,7 +44773,7 @@ paths: operationId: codespaces/list-selected-repos-for-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - *87 - *288 @@ -44790,7 +44808,7 @@ paths: description: |- Replaces all repositories for an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create - or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + or update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -44798,7 +44816,7 @@ paths: operationId: codespaces/set-selected-repos-for-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - *87 - *288 @@ -44815,8 +44833,8 @@ paths: secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization - secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) - and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) + secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. items: type: integer @@ -44842,14 +44860,14 @@ paths: put: summary: Add selected repository to an organization secret description: |- - Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/add-selected-repo-to-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - *87 - *288 @@ -44875,7 +44893,7 @@ paths: description: |- Removes a repository from an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create - or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + or update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -44883,7 +44901,7 @@ paths: operationId: codespaces/remove-selected-repo-from-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - *87 - *288 @@ -44904,6 +44922,1597 @@ paths: enabledForGitHubApps: false category: codespaces subcategory: organization-secrets + "/orgs/{org}/copilot-spaces": + get: + summary: List organization Copilot Spaces + description: |- + Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces. + + Only Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/copilot-spaces#list-organization-copilot-spaces + parameters: + - *87 + - name: per_page + description: The number of results per page (max 100). + in: query + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: before + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + in: query + schema: + type: string + - name: after + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. + in: query + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - spaces + properties: + spaces: + type: array + description: The list of Copilot Spaces on this page of results. + items: &322 + title: Space + description: A GitHub Copilot Space represents an interactive + AI workspace where users can ask questions and get assistance. + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the space. + examples: + - 42 + number: + type: integer + description: The number that identifies the space within + its owner. + examples: + - 1 + name: + type: string + description: The display name of the space. + examples: + - My Development Space + description: + type: + - string + - 'null' + description: A description of the space. + examples: + - A space for discussing React development patterns + general_instructions: + type: + - string + - 'null' + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Help with React development patterns and best practices + base_role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: |- + The base role that determines default permissions. + - `no_access`: No default access + - `reader`: Default read permissions + - `writer`: Default write permissions (organization spaces only) + - `admin`: Default admin permissions (organization spaces only) + examples: + - no_access + owner: + anyOf: + - *4 + - *73 + description: The user or organization that owns this space. + creator: *4 + created_at: + type: string + format: date-time + description: The date and time the space was created. + examples: + - '2023-01-01T00:00:00Z' + updated_at: + type: string + format: date-time + description: The date and time the space was last updated. + examples: + - '2023-01-01T12:00:00Z' + html_url: + type: string + format: uri + description: The HTML URL of the space. + examples: + - https://github.com/copilot/spaces/octo-org/5 + api_url: + type: string + format: uri + description: The API URL of the space. + examples: + - https://api.github.com/organizations/1/copilot-spaces/5 + resources_attributes: + type: array + description: Resources attached to the space. + items: + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the resource. + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + copilot_chat_attachment_id: + type: + - integer + - 'null' + format: int64 + description: The unique identifier of the chat attachment + for uploaded files or media content. + created_at: + type: string + format: date-time + description: The date and time the resource was created. + updated_at: + type: string + format: date-time + description: The date and time the resource was last + updated. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file + resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + copilot_chat_attachment_id: + type: integer + description: Chat attachment ID for uploaded files + or media. + media_type: + type: string + description: Media type for media content resources. + url: + type: string + description: URL for media content resources. + height: + type: integer + description: Height for media content resources. + width: + type: integer + description: Width for media content resources. + required: + - id + - number + - name + - base_role + - owner + - creator + - created_at + - updated_at + - html_url + - api_url + additionalProperties: false + examples: + default: + summary: Example response for listing organization copilot spaces + value: + spaces: + - id: 84 + number: 3 + name: Team Planning Space + description: Organization space for team planning and coordination + owner: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + gravatar_id: '' + name: octo-org + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: octo-org + html_url: https://github.com/octo-org + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + creator: + login: defunkt + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://github.com/images/error/defunkt_happy.gif + gravatar_id: '' + url: https://api.github.com/users/defunkt + html_url: https://github.com/defunkt + followers_url: https://api.github.com/users/defunkt/followers + following_url: https://api.github.com/users/defunkt/following{/other_user} + gists_url: https://api.github.com/users/defunkt/gists{/gist_id} + starred_url: https://api.github.com/users/defunkt/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/defunkt/subscriptions + organizations_url: https://api.github.com/users/defunkt/orgs + repos_url: https://api.github.com/users/defunkt/repos + events_url: https://api.github.com/users/defunkt/events{/privacy} + received_events_url: https://api.github.com/users/defunkt/received_events + type: User + site_admin: true + created_at: '2023-02-15T08:30:00Z' + updated_at: '2023-02-15T14:45:00Z' + html_url: https://github.com/copilot/spaces/octo-org/3 + api_url: https://api.github.com/organizations/1/copilot-spaces/3 + - id: 85 + number: 4 + name: Development Resources + description: Shared development documentation and resources + owner: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + gravatar_id: '' + name: octo-org + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: octo-org + html_url: https://github.com/octo-org + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + creator: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-16T10:15:00Z' + updated_at: '2023-02-16T16:30:00Z' + html_url: https://github.com/copilot/spaces/octo-org/4 + api_url: https://api.github.com/organizations/1/copilot-spaces/4 + headers: + Link: *45 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + post: + summary: Create an organization Copilot Space + description: |- + Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization. + + Organization members with appropriate permissions can create Copilot Spaces to be shared within their organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/copilot-spaces#create-an-organization-copilot-space + parameters: + - *87 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - Team Planning Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Organization space for team planning and coordination + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Help the team with planning and coordination tasks + base_role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: |- + The base role that determines default permissions for organization members. + - `no_access`: No default access (default) + - `reader`: Organization members can read the space + - `writer`: Organization members can read and edit the space + - `admin`: Organization members have full admin access to the space + default: no_access + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + required: + - name + examples: + default: + value: + name: Team Planning Space + description: Organization space for team planning and coordination + general_instructions: Help the team with planning and coordination + tasks + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 123456 + file_path: docs/planning.md + - resource_type: free_text + metadata: + name: Team Guidelines + text: Our team follows agile methodology and holds daily standups + responses: + '201': + description: Response + content: + application/json: + schema: *322 + examples: + default: &323 + summary: Example response for an organization copilot space + value: + id: 84 + number: 3 + name: Team Planning Space + description: Organization space for team planning and coordination + general_instructions: Help the team with agile planning, sprint + coordination, and project management best practices + owner: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + gravatar_id: '' + name: octo-org + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: octo-org + html_url: https://github.com/octo-org + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + creator: + login: defunkt + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://github.com/images/error/defunkt_happy.gif + gravatar_id: '' + url: https://api.github.com/users/defunkt + html_url: https://github.com/defunkt + followers_url: https://api.github.com/users/defunkt/followers + following_url: https://api.github.com/users/defunkt/following{/other_user} + gists_url: https://api.github.com/users/defunkt/gists{/gist_id} + starred_url: https://api.github.com/users/defunkt/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/defunkt/subscriptions + organizations_url: https://api.github.com/users/defunkt/orgs + repos_url: https://api.github.com/users/defunkt/repos + events_url: https://api.github.com/users/defunkt/events{/privacy} + received_events_url: https://api.github.com/users/defunkt/received_events + type: User + site_admin: true + created_at: '2023-02-15T08:30:00Z' + updated_at: '2023-02-15T14:45:00Z' + html_url: https://github.com/copilot/spaces/octo-org/3 + api_url: https://api.github.com/organizations/1/copilot-spaces/3 + base_role: no_access + resources_attributes: + - id: 123 + resource_type: github_file + metadata: + repository_id: 456 + file_path: docs/planning.md + - id: 124 + resource_type: free_text + metadata: + name: Team Guidelines + text: Our team follows agile methodology + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + "/orgs/{org}/copilot-spaces/{space_number}": + get: + summary: Get an organization Copilot Space + description: |- + Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space. + + Internal Spaces require the authenticated user to be a member of the organization or have been granted read permissions. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/copilot-spaces#get-an-organization-copilot-space + parameters: + - *87 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *322 + examples: + default: *323 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + put: + summary: Set an organization Copilot Space + description: |- + Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization. + + Organization members with appropriate permissions can update Copilot Spaces owned by their organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/copilot-spaces#set-an-organization-copilot-space + parameters: + - *87 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - Updated Team Planning Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Updated organization space for team planning and coordination + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Updated instructions to help the team with planning and coordination + tasks + base_role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: |- + The base role that determines default permissions for organization members. Changing this field requires admin permissions. + - `no_access`: No default access (default) + - `reader`: Organization members can read the space + - `writer`: Organization members can read and edit the space + - `admin`: Organization members have full admin access to the space + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + examples: + default: + value: + name: Updated Team Planning Space + description: Updated organization space for team planning and coordination + general_instructions: Updated instructions to help the team with + planning and coordination tasks + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 123456 + file_path: docs/updated-planning.md + - id: 789 + _destroy: true + - id: 456 + resource_type: free_text + metadata: + name: Updated Team Guidelines + text: Our updated team follows agile methodology and holds daily + standups + responses: + '200': + description: Response + content: + application/json: + schema: *322 + examples: + default: *323 + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + delete: + summary: Delete an organization Copilot Space + description: |- + Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization. + + **Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations. + + Organization members with appropriate permissions can delete Copilot Spaces owned by their organization. + + OAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/copilot-spaces#delete-an-organization-copilot-space + parameters: + - *87 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '204': + description: The Copilot Space has been successfully deleted. + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + "/orgs/{org}/copilot-spaces/{space_number}/collaborators": + get: + summary: List collaborators for an organization Copilot Space + description: |- + Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators. + + Each collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list. + + **Note:** Team collaborators listed here are teams that are defined in the organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-collaborators-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/collaborators#list-collaborators-for-an-organization-copilot-space + parameters: + - *87 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - collaborators + properties: + collaborators: + type: array + description: The list of collaborators for this Copilot Space. + items: &324 + title: Copilot Space Collaborator + description: A collaborator (user or team) of a Copilot Space + type: object + anyOf: + - allOf: + - *4 + - type: object + properties: + actor_type: + type: string + enum: + - User + description: The collaborator actor type. + role: + type: string + enum: + - reader + - writer + - admin + description: The role granted to the collaborator + required: + - actor_type + - role + - type: object + properties: + actor_type: + type: string + enum: + - Team + description: The collaborator actor type. + role: + type: string + enum: + - reader + - writer + - admin + description: The role granted to the collaborator + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + type: + type: string + enum: + - Team + description: + type: + - string + - 'null' + privacy: + type: string + notification_setting: + type: string + url: + type: string + format: uri + html_url: + type: string + format: uri + members_url: + type: string + repositories_url: + type: string + format: uri + organization_id: + type: integer + parent: + type: + - 'null' + required: + - actor_type + - role + - id + - node_id + - name + - slug + - type + examples: + default: + value: + collaborators: + - actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + - actor_type: Team + role: reader + id: 67890 + node_id: MDQ6VGVhbTY3ODkw + url: https://api.github.com/teams/67890 + html_url: https://github.com/orgs/octo-org/teams/developers + name: Developers + slug: developers + description: Team of developers + privacy: closed + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/67890/members{/member} + repositories_url: https://api.github.com/teams/67890/repos + parent: + created_at: '2017-07-14T16:53:42Z' + updated_at: '2017-08-17T12:37:15Z' + organization: + login: octo-org + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + post: + summary: Add a collaborator to an organization Copilot Space + description: |- + Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. + + **Note:** When adding users as collaborators, they must already be members of the organization. + When adding teams as collaborators, they must be defined in the organization. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/add-collaborator-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/collaborators#add-a-collaborator-to-an-organization-copilot-space + parameters: + - *87 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - actor_type + - actor_identifier + - role + properties: + actor_type: + type: string + enum: + - User + - Team + description: The type of actor (user or team). + actor_identifier: + type: string + description: The username (for users) or team slug (for teams). + The numeric ID of a user or team is also accepted. + role: + type: string + enum: + - reader + - writer + - admin + description: The role to grant to the collaborator. + examples: + user: + value: + actor_type: User + actor_identifier: octocat + role: writer + team: + value: + actor_type: Team + actor_identifier: developers + role: reader + responses: + '201': + description: Response + content: + application/json: + schema: *324 + examples: + user: + value: + actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + team: + value: + actor_type: Team + role: reader + id: 67890 + node_id: MDQ6VGVhbTY3ODkw + url: https://api.github.com/teams/67890 + html_url: https://github.com/orgs/octo-org/teams/developers + name: Developers + slug: developers + type: Team + description: Team of developers + privacy: closed + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/67890/members{/member} + repositories_url: https://api.github.com/teams/67890/repos + parent: + organization_id: 1 + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": + put: + summary: Set a collaborator role for an organization Copilot Space + description: |- + Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-collaborator-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-an-organization-copilot-space + parameters: + - *87 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (user or team). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username (for users) or team slug (for teams). The numeric + ID of a user or team is also accepted. + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - role + properties: + role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: The new role to grant to the collaborator. Use `no_access` + to remove the collaborator. + examples: + default: + value: + role: admin + responses: + '200': + description: Response + content: + application/json: + schema: *324 + examples: + user: + value: + actor_type: User + role: admin + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + team: + value: + actor_type: Team + role: admin + id: 67890 + node_id: MDQ6VGVhbTY3ODkw + url: https://api.github.com/teams/67890 + html_url: https://github.com/orgs/octo-org/teams/developers + name: Developers + slug: developers + type: Team + description: Team of developers + privacy: closed + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/67890/members{/member} + repositories_url: https://api.github.com/teams/67890/repos + parent: + organization_id: 1 + '204': + description: Response when `role` is `no_access` and the collaborator was + removed. + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + delete: + summary: Remove a collaborator from an organization Copilot Space + description: |- + Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/remove-collaborator-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/collaborators#remove-a-collaborator-from-an-organization-copilot-space + parameters: + - *87 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (user or team). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username (for users) or team slug (for teams). The numeric + ID of a user or team is also accepted. + in: path + required: true + schema: + type: string + responses: + '204': + description: Response + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: collaborators + "/orgs/{org}/copilot-spaces/{space_number}/resources": + get: + summary: List resources for an organization Copilot Space + description: |- + Lists all resources attached to a specific Copilot Space owned by an organization. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-resources-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/resources#list-resources-for-an-organization-copilot-space + parameters: + - *87 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - resources + properties: + resources: + type: array + description: The list of resources attached to this Copilot Space. + items: &325 + title: Copilot Space Resource + description: A resource attached to a Copilot Space. + type: object + properties: + id: + type: integer + description: The unique identifier of the resource. + resource_type: + type: string + description: The type of the resource. + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + copilot_chat_attachment_id: + type: + - integer + - 'null' + description: The ID of the associated chat attachment, if + any. + metadata: + type: object + description: Resource-specific metadata. The keys and values + depend on the resource type. + additionalProperties: true + created_at: + type: string + format: date-time + description: The date and time the resource was created. + updated_at: + type: string + format: date-time + description: The date and time the resource was last updated. + required: + - id + - resource_type + - metadata + - created_at + - updated_at + examples: + default: + value: + resources: + - id: 1 + resource_type: repository + copilot_chat_attachment_id: + metadata: + repository_id: 42 + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + - id: 2 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + post: + summary: Create a resource for an organization Copilot Space + description: |- + Creates a new resource in a specific Copilot Space owned by an organization. + The authenticated user must have write permissions on the space. + + The following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`. + The `uploaded_text_file` and `media_content` types are not supported via this endpoint. + + For `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/resources#create-a-resource-for-an-organization-copilot-space + parameters: + - *87 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - resource_type + - metadata + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + description: The type of resource to create. + metadata: + type: object + description: Resource-specific metadata. + additionalProperties: true + examples: + free_text: + value: + resource_type: free_text + metadata: + name: notes.txt + text: Some helpful notes + repository: + value: + resource_type: repository + metadata: + repository_id: 42 + github_file: + value: + resource_type: github_file + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + responses: + '201': + description: Resource created + content: + application/json: + schema: *325 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '200': + description: Duplicate github_file resource already exists + content: + application/json: + schema: *325 + examples: + default: + value: + id: 1 + resource_type: github_file + copilot_chat_attachment_id: + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": + get: + summary: Get a resource for an organization Copilot Space + description: |- + Gets a specific resource attached to a Copilot Space owned by an organization. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/resources#get-a-resource-for-an-organization-copilot-space + parameters: + - *87 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *325 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + put: + summary: Set a resource for an organization Copilot Space + description: |- + Updates the metadata of a resource in a specific Copilot Space owned by an organization. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/resources#set-a-resource-for-an-organization-copilot-space + parameters: + - *87 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + description: Updated resource-specific metadata. + additionalProperties: true + examples: + default: + value: + metadata: + name: updated-notes.txt + text: Updated content + responses: + '200': + description: Response + content: + application/json: + schema: *325 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: updated-notes.txt + text: Updated content + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T12:00:00Z' + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources + delete: + summary: Delete a resource from an organization Copilot Space + description: |- + Deletes a resource from a specific Copilot Space owned by an organization. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-resource-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/resources#delete-a-resource-from-an-organization-copilot-space + parameters: + - *87 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: resources "/orgs/{org}/copilot/billing": get: summary: Get Copilot seat information and settings for an organization @@ -44913,7 +46522,7 @@ paths: Gets information about an organization's Copilot subscription, including seat breakdown and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." + For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. @@ -44923,7 +46532,7 @@ paths: operationId: copilot/get-copilot-organization-details externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - *87 responses: @@ -45056,7 +46665,7 @@ paths: Only organization owners can view assigned seats. Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. - For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data). + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/reference/metrics-data). OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: @@ -45064,13 +46673,13 @@ paths: operationId: copilot/list-copilot-seats externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - *87 - *19 - name: per_page description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -45111,11 +46720,11 @@ paths: > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for all users within each specified team. - The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." - For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response contains the total number of new seats that were created and existing seats that were refreshed. @@ -45125,7 +46734,7 @@ paths: operationId: copilot/add-copilot-seats-for-teams externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - *87 requestBody: @@ -45191,7 +46800,7 @@ paths: Sets seats for all members of each team specified to "pending cancellation". This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. @@ -45203,7 +46812,7 @@ paths: operationId: copilot/cancel-copilot-seat-assignment-for-teams externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - *87 requestBody: @@ -45269,11 +46878,11 @@ paths: > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for each user specified. - The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." - For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response contains the total number of new seats that were created and existing seats that were refreshed. @@ -45283,7 +46892,7 @@ paths: operationId: copilot/add-copilot-seats-for-users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - *87 requestBody: @@ -45348,7 +46957,7 @@ paths: Sets seats for all users specified to "pending cancellation". This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. @@ -45360,7 +46969,7 @@ paths: operationId: copilot/cancel-copilot-seat-assignment-for-users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - *87 requestBody: @@ -45421,15 +47030,15 @@ paths: subcategory: copilot-user-management "/orgs/{org}/copilot/coding-agent/permissions": get: - summary: Get Copilot coding agent permissions for an organization + summary: Get Copilot cloud agent permissions for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Gets information about which repositories in an organization have been enabled - or disabled for the Copilot coding agent. + or disabled for the Copilot cloud agent. - Organization owners can configure whether Copilot coding agent is enabled for + Organization owners can configure whether Copilot cloud agent is enabled for all repositories, selected repositories, or no repositories owned by organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -45438,7 +47047,7 @@ paths: operationId: copilot/get-copilot-coding-agent-permissions-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#get-copilot-cloud-agent-permissions-for-an-organization parameters: - *87 responses: @@ -45452,7 +47061,7 @@ paths: enabled_repositories: type: string description: The policy for which repositories can use Copilot - coding agent. Can be one of `all`, `selected`, or `none`. + cloud agent. Can be one of `all`, `selected`, or `none`. enum: - all - selected @@ -45487,14 +47096,14 @@ paths: category: copilot subcategory: copilot-coding-agent-management put: - summary: Set Copilot coding agent permissions for an organization + summary: Set Copilot cloud agent permissions for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. - Sets the policy for which repositories in an organization can use Copilot coding agent. + Sets the policy for which repositories in an organization can use Copilot cloud agent. - Organization owners can configure whether Copilot coding agent is enabled for + Organization owners can configure whether Copilot cloud agent is enabled for all repositories, selected repositories, or no repositories owned by the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -45503,7 +47112,7 @@ paths: operationId: copilot/set-copilot-coding-agent-permissions-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#set-copilot-cloud-agent-permissions-for-an-organization parameters: - *87 requestBody: @@ -45515,7 +47124,7 @@ paths: properties: enabled_repositories: type: string - description: The policy for which repositories can use Copilot coding + description: The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`. enum: - all @@ -45542,12 +47151,12 @@ paths: subcategory: copilot-coding-agent-management "/orgs/{org}/copilot/coding-agent/permissions/repositories": get: - summary: List repositories enabled for Copilot coding agent in an organization + summary: List repositories enabled for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists the selected repositories that are enabled for Copilot coding agent in an organization. + Lists the selected repositories that are enabled for Copilot cloud agent in an organization. Organization owners can use this endpoint when the coding agent repository policy is set to `selected` to see which repositories have been enabled. @@ -45558,7 +47167,7 @@ paths: operationId: copilot/list-copilot-coding-agent-selected-repositories-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-cloud-agent-in-an-organization parameters: - *87 - *17 @@ -45580,7 +47189,7 @@ paths: - total_count - repositories examples: - default: *322 + default: *326 '500': *38 '401': *23 '403': *27 @@ -45592,13 +47201,13 @@ paths: category: copilot subcategory: copilot-coding-agent-management put: - summary: Set selected repositories for Copilot coding agent in an organization + summary: Set selected repositories for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. - Replaces the list of selected repositories that are enabled for Copilot coding - agent in an organization. This method can only be called when the coding agent + Replaces the list of selected repositories that are enabled for Copilot cloud + agent in an organization. This method can only be called when the cloud agent repository policy is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -45607,7 +47216,7 @@ paths: operationId: copilot/set-copilot-coding-agent-selected-repositories-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-cloud-agent-in-an-organization parameters: - *87 requestBody: @@ -45618,7 +47227,7 @@ paths: type: object properties: selected_repository_ids: - description: List of repository IDs to enable for Copilot coding + description: List of repository IDs to enable for Copilot cloud agent. type: array items: @@ -45648,14 +47257,14 @@ paths: subcategory: copilot-coding-agent-management "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}": put: - summary: Enable a repository for Copilot coding agent in an organization + summary: Enable a repository for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Adds a repository to the list of selected repositories enabled for Copilot - coding agent in an organization. This method can only be called when the - coding agent repository policy is set to `selected`. + cloud agent in an organization. This method can only be called when the + cloud agent repository policy is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -45663,7 +47272,7 @@ paths: operationId: copilot/enable-copilot-coding-agent-for-repository-in-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-cloud-agent-in-an-organization parameters: - *87 - *272 @@ -45682,14 +47291,14 @@ paths: category: copilot subcategory: copilot-coding-agent-management delete: - summary: Disable a repository for Copilot coding agent in an organization + summary: Disable a repository for Copilot cloud agent in an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Removes a repository from the list of selected repositories enabled for Copilot - coding agent in an organization. This method can only be called when the - coding agent repository policy is set to `selected`. + cloud agent in an organization. This method can only be called when the + cloud agent repository policy is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint. tags: @@ -45697,7 +47306,7 @@ paths: operationId: copilot/disable-copilot-coding-agent-for-repository-in-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-cloud-agent-in-an-organization parameters: - *87 - *272 @@ -45723,7 +47332,7 @@ paths: Gets information about an organization's Copilot content exclusion path rules. To configure these settings, go to the organization's settings on GitHub. - For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." + For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." Organization owners can view details about Copilot content exclusion rules for the organization. @@ -45737,7 +47346,7 @@ paths: operationId: copilot/copilot-content-exclusion-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization parameters: - *87 responses: @@ -45776,7 +47385,7 @@ paths: Sets Copilot content exclusion path rules for an organization. To configure these settings, go to the organization's settings on GitHub. - For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." + For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." Organization owners can set Copilot content exclusion rules for the organization. @@ -45790,7 +47399,7 @@ paths: operationId: copilot/set-copilot-content-exclusion-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization parameters: - *87 requestBody: @@ -45848,7 +47457,7 @@ paths: '401': *23 '403': *27 '404': *6 - '413': *323 + '413': *327 '422': *7 x-github: githubCloudOnly: @@ -45877,7 +47486,7 @@ paths: operationId: copilot/copilot-metrics-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - *87 - name: since @@ -45899,7 +47508,7 @@ paths: - *19 - name: per_page description: The number of days of metrics to display per page (max 100). - For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -45935,13 +47544,13 @@ paths: Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). tags: - copilot operationId: copilot/copilot-organization-one-day-usage-metrics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day parameters: - *87 - *121 @@ -45974,13 +47583,13 @@ paths: Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). tags: - copilot operationId: copilot/copilot-organization-usage-metrics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics parameters: - *87 responses: @@ -46011,13 +47620,13 @@ paths: Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). tags: - copilot operationId: copilot/copilot-organization-users-one-day-usage-metrics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day parameters: - *87 - *121 @@ -46050,13 +47659,13 @@ paths: Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). tags: - copilot operationId: copilot/copilot-organization-users-usage-metrics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics parameters: - *87 responses: @@ -46079,7 +47688,7 @@ paths: get: summary: List SAML SSO authorizations for an organization description: |- - Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/enterprise-cloud@latest//articles/about-authentication-with-saml-single-sign-on). + Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/enterprise-cloud@latest/articles/about-authentication-with-saml-single-sign-on). The authenticated user must be an organization owner to use this endpoint. @@ -46089,7 +47698,7 @@ paths: operationId: orgs/list-saml-sso-authorizations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization parameters: - *87 - *17 @@ -46248,7 +47857,7 @@ paths: operationId: orgs/remove-saml-sso-authorization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization parameters: - *87 - name: credential_id @@ -46269,7 +47878,7 @@ paths: get: summary: List custom repository roles in an organization description: |- - List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. @@ -46279,7 +47888,7 @@ paths: operationId: orgs/list-custom-repo-roles externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization parameters: - *87 responses: @@ -46297,7 +47906,7 @@ paths: - 3 custom_roles: type: array - items: *324 + items: *328 examples: default: value: @@ -46372,7 +47981,7 @@ paths: post: summary: Create a custom repository role description: |- - Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -46382,14 +47991,14 @@ paths: operationId: orgs/create-custom-repo-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#create-a-custom-repository-role parameters: - *87 requestBody: required: true content: application/json: - schema: &326 + schema: &330 type: object properties: name: @@ -46431,9 +48040,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *328 examples: - default: *325 + default: *329 '422': *15 '404': *6 x-github: @@ -46445,7 +48054,7 @@ paths: get: summary: Get a custom repository role description: |- - Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. @@ -46455,7 +48064,7 @@ paths: operationId: orgs/get-custom-repo-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#get-a-custom-repository-role parameters: - *87 - *139 @@ -46464,9 +48073,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *328 examples: - default: *325 + default: *329 '404': *6 x-github: githubCloudOnly: true @@ -46476,7 +48085,7 @@ paths: patch: summary: Update a custom repository role description: |- - Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -46486,7 +48095,7 @@ paths: operationId: orgs/update-custom-repo-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#update-a-custom-repository-role parameters: - *87 - *139 @@ -46494,7 +48103,7 @@ paths: required: true content: application/json: - schema: &327 + schema: &331 type: object properties: name: @@ -46533,9 +48142,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *328 examples: - default: *325 + default: *329 '422': *15 '404': *6 x-github: @@ -46547,7 +48156,7 @@ paths: summary: Delete a custom repository role description: |- 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. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -46557,7 +48166,7 @@ paths: operationId: orgs/delete-custom-repo-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#delete-a-custom-repository-role parameters: - *87 - *139 @@ -46574,9 +48183,9 @@ paths: summary: Closing down - Create a custom role description: |- > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Create a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role)" endpoint instead. + > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Create a custom repository role](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#create-a-custom-repository-role)" endpoint instead. - Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -46586,14 +48195,14 @@ paths: operationId: orgs/create-custom-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---create-a-custom-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---create-a-custom-role parameters: - *87 requestBody: required: true content: application/json: - schema: *326 + schema: *330 examples: default: value: @@ -46607,9 +48216,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *328 examples: - default: *325 + default: *329 '422': *15 '404': *6 x-github: @@ -46625,9 +48234,9 @@ paths: summary: Closing down - Get a custom role description: |- > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Get a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role)" endpoint instead. + > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Get a custom repository role](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#get-a-custom-repository-role)" endpoint instead. - Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. @@ -46637,7 +48246,7 @@ paths: operationId: orgs/get-custom-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---get-a-custom-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---get-a-custom-role parameters: - *87 - *139 @@ -46646,9 +48255,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *328 examples: - default: *325 + default: *329 '404': *6 x-github: githubCloudOnly: true @@ -46662,9 +48271,9 @@ paths: summary: Closing down - Update a custom role description: |- > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Update a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role)" endpoint instead. + > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Update a custom repository role](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#update-a-custom-repository-role)" endpoint instead. - Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -46674,7 +48283,7 @@ paths: operationId: orgs/update-custom-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---update-a-custom-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---update-a-custom-role parameters: - *87 - *139 @@ -46682,7 +48291,7 @@ paths: required: true content: application/json: - schema: *327 + schema: *331 examples: default: value: @@ -46697,9 +48306,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *328 examples: - default: *325 + default: *329 '422': *15 '404': *6 x-github: @@ -46714,10 +48323,10 @@ paths: summary: Closing down - Delete a custom role description: |- > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Delete a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role)" endpoint instead. + > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Delete a custom repository role](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#delete-a-custom-repository-role)" endpoint instead. 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. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -46727,7 +48336,7 @@ paths: operationId: orgs/delete-custom-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---delete-a-custom-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---delete-a-custom-role parameters: - *87 - *139 @@ -46756,15 +48365,15 @@ paths: operationId: dependabot/list-alerts-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *87 - - *328 - - *329 - - *330 - - *331 - *332 - *333 + - *334 + - *335 + - *336 + - *337 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -46794,7 +48403,7 @@ paths: enum: - patch - deployment - - *334 + - *338 - name: runtime_risk in: query description: |- @@ -46803,8 +48412,8 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *335 - - *336 + - *339 + - *340 - *110 - *108 - *109 @@ -46816,9 +48425,9 @@ paths: application/json: schema: type: array - items: *337 + items: *341 examples: - default: *338 + default: *342 '304': *35 '400': *14 '403': *27 @@ -46842,7 +48451,7 @@ paths: operationId: dependabot/repository-access-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization parameters: - *87 - name: page @@ -46867,9 +48476,9 @@ paths: description: Response content: application/json: - schema: *339 + schema: *343 examples: - default: *340 + default: *344 '403': *27 '404': *6 x-github: @@ -46898,7 +48507,7 @@ paths: operationId: dependabot/update-repository-access-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - *87 requestBody: @@ -46964,7 +48573,7 @@ paths: operationId: dependabot/set-repository-access-default-level externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - *87 requestBody: @@ -47013,7 +48622,7 @@ paths: operationId: dependabot/list-org-secrets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-organization-secrets parameters: - *87 - *17 @@ -47033,7 +48642,7 @@ paths: type: integer secrets: type: array - items: &341 + items: &345 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -47104,7 +48713,7 @@ paths: operationId: dependabot/get-org-public-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-an-organization-public-key parameters: - *87 responses: @@ -47112,7 +48721,7 @@ paths: description: Response content: application/json: - schema: &598 + schema: &602 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -47131,7 +48740,7 @@ paths: - key_id - key examples: - default: &599 + default: &603 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -47152,7 +48761,7 @@ paths: operationId: dependabot/get-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-an-organization-secret parameters: - *87 - *288 @@ -47161,7 +48770,7 @@ paths: description: Response content: application/json: - schema: *341 + schema: *345 examples: default: value: @@ -47179,7 +48788,7 @@ paths: summary: Create or update an organization secret description: |- Creates or updates an organization secret with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -47187,7 +48796,7 @@ paths: operationId: dependabot/create-or-update-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - *87 - *288 @@ -47202,7 +48811,7 @@ paths: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public - key](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key) + key](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-an-organization-public-key) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: @@ -47223,9 +48832,9 @@ paths: secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for - an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), - [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), - and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) + an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), + [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. items: anyOf: @@ -47269,7 +48878,7 @@ paths: operationId: dependabot/delete-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#delete-an-organization-secret parameters: - *87 - *288 @@ -47294,7 +48903,7 @@ paths: operationId: dependabot/list-selected-repos-for-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - *87 - *288 @@ -47328,7 +48937,7 @@ paths: description: |- Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create - or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret). + or update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-an-organization-secret). OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -47336,7 +48945,7 @@ paths: operationId: dependabot/set-selected-repos-for-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - *87 - *288 @@ -47353,8 +48962,8 @@ paths: secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization - secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) - and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) + secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. items: type: integer @@ -47379,7 +48988,7 @@ paths: description: |- Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or - update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret). + update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-an-organization-secret). OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -47387,7 +48996,7 @@ paths: operationId: dependabot/add-selected-repo-to-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#add-selected-repository-to-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - *87 - *288 @@ -47411,7 +49020,7 @@ paths: description: |- Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create - or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret). + or update an organization secret](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-an-organization-secret). OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -47419,7 +49028,7 @@ paths: operationId: dependabot/remove-selected-repo-from-org-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - *87 - *288 @@ -47451,7 +49060,7 @@ paths: operationId: code-scanning/list-org-dismissal-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/alert-dismissal-requests#list-dismissal-requests-for-code-scanning-alerts-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/alert-dismissal-requests#list-dismissal-requests-for-code-scanning-alerts-for-an-organization x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -47459,7 +49068,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *87 - - &608 + - &612 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -47467,7 +49076,7 @@ paths: required: false schema: type: string - - &609 + - &613 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -47475,7 +49084,7 @@ paths: required: false schema: type: string - - &610 + - &614 name: time_period description: |- The time period to filter by. @@ -47491,7 +49100,7 @@ paths: - week - month default: month - - &611 + - &615 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -47516,7 +49125,7 @@ paths: application/json: schema: type: array - items: &612 + items: &616 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -47626,7 +49235,7 @@ paths: - array - 'null' description: The responses to the dismissal request. - items: &343 + items: &347 title: Dismissal request response description: A response made by a requester to dismiss the request. @@ -47679,7 +49288,7 @@ paths: examples: - https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &613 + default: &617 value: - id: 21 number: 42 @@ -47759,7 +49368,7 @@ paths: operationId: dependabot/list-dismissal-requests-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#list-dismissal-requests-for-dependabot-alerts-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#list-dismissal-requests-for-dependabot-alerts-for-an-organization x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -47771,7 +49380,7 @@ paths: - *103 - *104 - *105 - - *342 + - *346 - *17 - *19 responses: @@ -47781,7 +49390,7 @@ paths: application/json: schema: type: array - items: &614 + items: &618 title: Dependabot alert dismissal request description: Alert dismissal request made by a user asking to dismiss a Dependabot alert. @@ -47891,7 +49500,7 @@ paths: - array - 'null' description: The responses to the dismissal request. - items: *343 + items: *347 url: type: string format: uri @@ -47904,7 +49513,7 @@ paths: examples: - https://github.com/octo-org/smile/security/dependabot/1 examples: - default: &615 + default: &619 value: - id: 21 number: 42 @@ -47984,7 +49593,7 @@ paths: operationId: secret-scanning/list-org-dismissal-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-an-org + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-an-org x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -47996,7 +49605,7 @@ paths: - *103 - *104 - *105 - - *342 + - *346 - *17 - *19 responses: @@ -48006,9 +49615,9 @@ paths: application/json: schema: type: array - items: *344 + items: *348 examples: - default: *345 + default: *349 '404': *6 '403': *27 '500': *38 @@ -48024,7 +49633,7 @@ paths: operationId: packages/list-docker-migration-conflicting-packages-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - *87 responses: @@ -48034,7 +49643,7 @@ paths: application/json: schema: type: array - items: &391 + items: &395 title: Package description: A software package type: object @@ -48105,7 +49714,7 @@ paths: - created_at - updated_at examples: - default: &392 + default: &396 value: - id: 197 name: hello_docker @@ -48181,7 +49790,7 @@ paths: operationId: activity/list-public-org-events externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-organization-events parameters: - *87 - *17 @@ -48258,13 +49867,13 @@ paths: description: |- Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. - You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. tags: - teams operationId: teams/external-idp-group-info-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/external-groups#get-an-external-group parameters: - *87 - name: group_id @@ -48275,14 +49884,14 @@ paths: type: integer - name: per_page description: The number of results per page for the "members" array (max 100). - For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 30 - name: page description: The page number of the "members" array results to fetch. For - more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -48292,7 +49901,7 @@ paths: description: Response content: application/json: - schema: &458 + schema: &462 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -48382,7 +49991,7 @@ paths: member_name: Octo Lisa member_email: octo_lisa@github.com examples: - default: &459 + default: &463 value: group_id: '123' group_name: Octocat admins @@ -48412,13 +50021,13 @@ paths: description: |- Lists external groups provisioned on the enterprise that are available to an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Cloud generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." - You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. tags: - teams operationId: teams/list-external-idp-groups-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-external-groups-available-to-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/external-groups#list-external-groups-available-to-an-organization parameters: - *87 - *17 @@ -48437,7 +50046,7 @@ paths: description: Response content: application/json: - schema: &455 + schema: &459 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -48477,7 +50086,7 @@ paths: group_name: group-azuread-test2 updated_at: 2021-06-03 22:27:15:000 -700 examples: - default: &456 + default: &460 value: groups: - group_id: '123' @@ -48504,13 +50113,13 @@ 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. - This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). + This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). tags: - orgs operationId: orgs/list-failed-invitations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-failed-organization-invitations parameters: - *87 - *17 @@ -48522,7 +50131,7 @@ paths: application/json: schema: type: array - items: &370 + items: &374 title: Organization Invitation description: Organization Invitation type: object @@ -48576,7 +50185,7 @@ paths: - invitation_teams_url - node_id examples: - default: &371 + default: &375 value: - id: 1 login: monalisa @@ -48621,9 +50230,9 @@ paths: summary: Closing down - List fine-grained permissions for an organization description: |- > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[List fine-grained repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" endpoint instead. + > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[List fine-grained repository permissions](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" endpoint instead. - Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." To use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization. @@ -48633,7 +50242,7 @@ paths: operationId: orgs/list-fine-grained-permissions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-fine-grained-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#closing-down---list-fine-grained-permissions-for-an-organization parameters: - *87 responses: @@ -48643,7 +50252,7 @@ paths: application/json: schema: type: array - items: &422 + items: &426 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -48657,7 +50266,7 @@ paths: - name - description examples: - default: &423 + default: &427 value: - name: add_assignee description: Assign or remove a user @@ -48686,7 +50295,7 @@ paths: operationId: orgs/list-webhooks externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#list-organization-webhooks parameters: - *87 - *17 @@ -48698,7 +50307,7 @@ paths: application/json: schema: type: array - items: &346 + items: &350 title: Org Hook description: Org Hook type: object @@ -48817,7 +50426,7 @@ paths: operationId: orgs/create-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#create-an-organization-webhook parameters: - *87 requestBody: @@ -48850,7 +50459,7 @@ paths: - url events: type: array - description: Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) + description: Determines what [events](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. default: @@ -48881,9 +50490,9 @@ paths: description: Response content: application/json: - schema: *346 + schema: *350 examples: - default: &347 + default: &351 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -48925,10 +50534,10 @@ paths: operationId: orgs/get-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#get-an-organization-webhook parameters: - *87 - - &348 + - &352 name: hook_id description: The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. @@ -48941,9 +50550,9 @@ paths: description: Response content: application/json: - schema: *346 + schema: *350 examples: - default: *347 + default: *351 '404': *6 x-github: githubCloudOnly: false @@ -48962,10 +50571,10 @@ paths: operationId: orgs/update-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#update-an-organization-webhook parameters: - *87 - - *348 + - *352 requestBody: required: false content: @@ -48985,7 +50594,7 @@ paths: - url events: type: array - description: Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) + description: Determines what [events](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads) the hook is triggered for. default: - push @@ -49011,7 +50620,7 @@ paths: description: Response content: application/json: - schema: *346 + schema: *350 examples: default: value: @@ -49048,10 +50657,10 @@ paths: operationId: orgs/delete-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#delete-an-organization-webhook parameters: - *87 - - *348 + - *352 responses: '204': description: Response @@ -49074,10 +50683,10 @@ paths: operationId: orgs/get-webhook-config-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *87 - - *348 + - *352 responses: '200': description: Response @@ -49103,10 +50712,10 @@ paths: operationId: orgs/update-webhook-config-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *87 - - *348 + - *352 requestBody: required: false content: @@ -49152,13 +50761,13 @@ paths: operationId: orgs/list-webhook-deliveries externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *87 - - *348 + - *352 - *17 - - *349 - - *350 + - *353 + - *354 responses: '200': description: Response @@ -49166,9 +50775,9 @@ paths: application/json: schema: type: array - items: *351 + items: *355 examples: - default: *352 + default: *356 '400': *14 '422': *15 x-github: @@ -49189,19 +50798,19 @@ paths: operationId: orgs/get-webhook-delivery externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *87 - - *348 + - *352 - *16 responses: '200': description: Response content: application/json: - schema: *353 + schema: *357 examples: - default: *354 + default: *358 '400': *14 '422': *15 x-github: @@ -49222,10 +50831,10 @@ paths: operationId: orgs/redeliver-webhook-delivery externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *87 - - *348 + - *352 - *16 responses: '202': *37 @@ -49249,10 +50858,10 @@ paths: operationId: orgs/ping-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/webhooks#ping-an-organization-webhook parameters: - *87 - - *348 + - *352 responses: '204': description: Response @@ -49272,10 +50881,10 @@ paths: operationId: api-insights/get-route-stats-by-actor externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-route-stats-by-actor parameters: - *87 - - &359 + - &363 name: actor_type in: path description: The type of the actor @@ -49288,14 +50897,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &360 + - &364 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &355 + - &359 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -49303,7 +50912,7 @@ paths: required: true schema: type: string - - &356 + - &360 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -49395,15 +51004,15 @@ paths: operationId: api-insights/get-subject-stats externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-subject-stats parameters: - *87 - - *355 - - *356 + - *359 + - *360 - *19 - *17 - *110 - - &365 + - &369 name: sort description: The property to sort the results by. in: query @@ -49479,17 +51088,17 @@ paths: operationId: api-insights/get-summary-stats externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-summary-stats parameters: - *87 - - *355 - - *356 + - *359 + - *360 responses: '200': description: Response content: application/json: - schema: &357 + schema: &361 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -49505,7 +51114,7 @@ paths: type: integer format: int64 examples: - default: &358 + default: &362 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -49523,26 +51132,26 @@ paths: operationId: api-insights/get-summary-stats-by-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-summary-stats-by-user parameters: - *87 - - &361 + - &365 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *355 - - *356 + - *359 + - *360 responses: '200': description: Response content: application/json: - schema: *357 + schema: *361 examples: - default: *358 + default: *362 x-github: enabledForGitHubApps: true category: orgs @@ -49558,21 +51167,21 @@ paths: operationId: api-insights/get-summary-stats-by-actor externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - *87 - - *355 - - *356 - *359 - *360 + - *363 + - *364 responses: '200': description: Response content: application/json: - schema: *357 + schema: *361 examples: - default: *358 + default: *362 x-github: enabledForGitHubApps: true category: orgs @@ -49587,12 +51196,12 @@ paths: operationId: api-insights/get-time-stats externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-time-stats parameters: - *87 - - *355 - - *356 - - &362 + - *359 + - *360 + - &366 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -49605,7 +51214,7 @@ paths: description: Response content: application/json: - schema: &363 + schema: &367 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -49621,7 +51230,7 @@ paths: type: integer format: int64 examples: - default: &364 + default: &368 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -49655,21 +51264,21 @@ paths: operationId: api-insights/get-time-stats-by-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-time-stats-by-user parameters: - *87 - - *361 - - *355 - - *356 - - *362 + - *365 + - *359 + - *360 + - *366 responses: '200': description: Response content: application/json: - schema: *363 + schema: *367 examples: - default: *364 + default: *368 x-github: enabledForGitHubApps: true category: orgs @@ -49684,22 +51293,22 @@ paths: operationId: api-insights/get-time-stats-by-actor externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-time-stats-by-actor parameters: - *87 + - *363 + - *364 - *359 - *360 - - *355 - - *356 - - *362 + - *366 responses: '200': description: Response content: application/json: - schema: *363 + schema: *367 examples: - default: *364 + default: *368 x-github: enabledForGitHubApps: true category: orgs @@ -49714,16 +51323,16 @@ paths: operationId: api-insights/get-user-stats externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/api-insights#get-user-stats parameters: - *87 - - *361 - - *355 - - *356 + - *365 + - *359 + - *360 - *19 - *17 - *110 - - *365 + - *369 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -49791,13 +51400,13 @@ paths: description: |- Enables an authenticated GitHub App to find the organization's installation information. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-org-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-organization-installation-for-the-authenticated-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - *87 responses: @@ -49807,7 +51416,7 @@ paths: application/json: schema: *20 examples: - default: *366 + default: *370 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -49828,7 +51437,7 @@ paths: operationId: orgs/list-app-installations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - *87 - *17 @@ -49917,7 +51526,7 @@ paths: operationId: interactions/get-restrictions-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - *87 responses: @@ -49927,12 +51536,12 @@ paths: application/json: schema: anyOf: - - &368 + - &372 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &367 + limit: &371 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -49960,7 +51569,7 @@ paths: properties: {} additionalProperties: false examples: - default: &369 + default: &373 value: limit: collaborators_only origin: organization @@ -49982,20 +51591,20 @@ paths: operationId: interactions/set-restrictions-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - *87 requestBody: required: true content: application/json: - schema: &646 + schema: &650 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *367 + limit: *371 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -50020,9 +51629,9 @@ paths: description: Response content: application/json: - schema: *368 + schema: *372 examples: - default: *369 + default: *373 '422': *15 x-github: githubCloudOnly: false @@ -50038,7 +51647,7 @@ paths: operationId: interactions/remove-restrictions-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - *87 responses: @@ -50058,13 +51667,13 @@ paths: `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`. - This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). + This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). tags: - orgs operationId: orgs/list-pending-invitations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-pending-organization-invitations parameters: - *87 - *17 @@ -50100,9 +51709,9 @@ paths: application/json: schema: type: array - items: *370 + items: *374 examples: - default: *371 + default: *375 headers: Link: *45 '404': *6 @@ -50116,15 +51725,15 @@ paths: description: |- Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. - This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). + This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-cloud@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. tags: - orgs operationId: orgs/create-invitation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#create-an-organization-invitation parameters: - *87 requestBody: @@ -50180,7 +51789,7 @@ paths: description: Response content: application/json: - schema: *370 + schema: *374 examples: default: value: @@ -50226,18 +51835,18 @@ paths: description: |- Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. - This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). + This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). tags: - orgs operationId: orgs/cancel-invitation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#cancel-an-organization-invitation parameters: - *87 - - &372 + - &376 name: invitation_id description: The unique identifier of the invitation. in: path @@ -50262,16 +51871,16 @@ paths: List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. - This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). + This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). tags: - orgs operationId: orgs/list-invitation-teams externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-organization-invitation-teams parameters: - *87 - - *372 + - *376 - *17 - *19 responses: @@ -50283,7 +51892,7 @@ paths: type: array items: *307 examples: - default: &390 + default: &394 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -50316,7 +51925,7 @@ paths: operationId: orgs/list-issue-fields externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-fields#list-issue-fields-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-fields#list-issue-fields-for-an-organization parameters: - *87 responses: @@ -50326,7 +51935,7 @@ paths: application/json: schema: type: array - items: &373 + items: &377 title: Issue Field description: A custom attribute defined at the organization level for attaching structured data to issues. @@ -50465,7 +52074,7 @@ paths: description: |- Creates a new issue field for an organization. - You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization). + You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-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. @@ -50474,7 +52083,7 @@ paths: operationId: orgs/create-issue-field externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-fields#create-issue-field-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-fields#create-issue-field-for-an-organization parameters: - *87 requestBody: @@ -50569,9 +52178,9 @@ paths: description: Response content: application/json: - schema: *373 + schema: *377 examples: - default: &374 + default: &378 value: id: 512 node_id: IF_kwDNAd3NAZr @@ -50615,7 +52224,7 @@ paths: description: |- Updates an issue field for an organization. - You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization). + You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-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. @@ -50624,10 +52233,10 @@ paths: operationId: orgs/update-issue-field externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-fields#update-issue-field-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-fields#update-issue-field-for-an-organization parameters: - *87 - - &375 + - &379 name: issue_field_id description: The unique identifier of the issue field. in: path @@ -50737,9 +52346,9 @@ paths: description: Response content: application/json: - schema: *373 + schema: *377 examples: - default: *374 + default: *378 '404': *6 '422': *7 x-github: @@ -50752,7 +52361,7 @@ paths: description: |- Deletes an issue field for an organization. - You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization). + You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-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. @@ -50761,10 +52370,10 @@ paths: operationId: orgs/delete-issue-field externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-fields#delete-issue-field-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-fields#delete-issue-field-for-an-organization parameters: - *87 - - *375 + - *379 responses: '204': *126 '404': *6 @@ -50784,7 +52393,7 @@ paths: operationId: orgs/list-issue-types externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#list-issue-types-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - *87 responses: @@ -50794,7 +52403,7 @@ paths: application/json: schema: type: array - items: *376 + items: *380 examples: default: value: @@ -50821,7 +52430,7 @@ paths: description: |- 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). + 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. @@ -50830,7 +52439,7 @@ paths: operationId: orgs/create-issue-type externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#create-issue-type-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - *87 requestBody: @@ -50882,9 +52491,9 @@ paths: description: Response content: application/json: - schema: *376 + schema: *380 examples: - default: &377 + default: &381 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -50905,7 +52514,7 @@ paths: description: |- 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). + 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. @@ -50914,10 +52523,10 @@ paths: operationId: orgs/update-issue-type externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#update-issue-type-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *87 - - &378 + - &382 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -50973,9 +52582,9 @@ paths: description: Response content: application/json: - schema: *376 + schema: *380 examples: - default: *377 + default: *381 '404': *6 '422': *7 x-github: @@ -50988,7 +52597,7 @@ paths: description: |- 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). + 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. @@ -50997,10 +52606,10 @@ paths: operationId: orgs/delete-issue-type externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#delete-issue-type-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *87 - - *378 + - *382 responses: '204': description: Response @@ -51018,9 +52627,9 @@ paths: List issues in an organization assigned to the authenticated user. > [!NOTE] - > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests)" endpoint. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -51031,7 +52640,7 @@ paths: operationId: issues/list-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - *87 - name: filter @@ -51063,7 +52672,7 @@ paths: - closed - all default: open - - *379 + - *383 - name: type description: Can be the name of an issue type. in: query @@ -51094,7 +52703,7 @@ paths: type: array items: *219 examples: - default: *380 + default: *384 headers: Link: *45 '404': *6 @@ -51114,14 +52723,14 @@ paths: operationId: orgs/list-members externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-organization-members parameters: - *87 - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure - 2FA methods](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) + 2FA methods](https://docs.github.com/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners. in: query required: false @@ -51172,7 +52781,7 @@ paths: operationId: orgs/check-membership-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#check-organization-membership-for-a-user parameters: - *87 - *140 @@ -51207,7 +52816,7 @@ paths: operationId: orgs/remove-member externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#remove-an-organization-member parameters: - *87 - *140 @@ -51232,7 +52841,7 @@ paths: operationId: codespaces/get-codespaces-for-user-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#list-codespaces-for-a-user-in-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#list-codespaces-for-a-user-in-organization parameters: - *17 - *19 @@ -51253,9 +52862,9 @@ paths: type: integer codespaces: type: array - items: *381 + items: *385 examples: - default: *382 + default: *386 '304': *35 '500': *38 '401': *23 @@ -51278,11 +52887,11 @@ paths: operationId: codespaces/delete-from-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - *87 - *140 - - &383 + - &387 name: codespace_name in: path required: true @@ -51313,19 +52922,19 @@ paths: operationId: codespaces/stop-in-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#stop-a-codespace-for-an-organization-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - *87 - *140 - - *383 + - *387 responses: '200': description: Response content: application/json: - schema: *381 + schema: *385 examples: - default: &564 + default: &568 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -51486,7 +53095,7 @@ paths: Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. - For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data). + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest/copilot/reference/metrics-data). Only organization owners can view Copilot seat assignment details for members of their organization. @@ -51496,7 +53105,7 @@ paths: operationId: copilot/get-copilot-seat-details-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - *87 - *140 @@ -51572,7 +53181,7 @@ paths: operationId: orgs/get-membership-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#get-organization-membership-for-a-user parameters: - *87 - *140 @@ -51581,7 +53190,7 @@ paths: description: Response content: application/json: - schema: &384 + schema: &388 title: Org Membership description: Org Membership type: object @@ -51650,7 +53259,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &385 + response-if-user-has-an-active-admin-membership-with-organization: &389 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -51705,7 +53314,7 @@ paths: description: "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an - email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user) + email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user @@ -51720,7 +53329,7 @@ paths: operationId: orgs/set-membership-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#set-organization-membership-for-a-user parameters: - *87 - *140 @@ -51751,9 +53360,9 @@ paths: description: Response content: application/json: - schema: *384 + schema: *388 examples: - response-if-user-already-had-membership-with-organization: *385 + response-if-user-already-had-membership-with-organization: *389 '422': *15 '403': *27 x-github: @@ -51775,7 +53384,7 @@ paths: operationId: orgs/remove-membership-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#remove-organization-membership-for-a-user parameters: - *87 - *140 @@ -51801,7 +53410,7 @@ paths: operationId: migrations/list-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#list-organization-migrations parameters: - *87 - *17 @@ -51825,7 +53434,7 @@ paths: application/json: schema: type: array - items: &386 + items: &390 title: Migration description: A migration. type: object @@ -52080,7 +53689,7 @@ paths: operationId: migrations/start-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#start-an-organization-migration parameters: - *87 requestBody: @@ -52163,7 +53772,7 @@ paths: description: Response content: application/json: - schema: *386 + schema: *390 examples: default: value: @@ -52339,10 +53948,10 @@ paths: operationId: migrations/get-status-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#get-an-organization-migration-status parameters: - *87 - - &387 + - &391 name: migration_id description: The unique identifier of the migration. in: path @@ -52370,7 +53979,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *386 + schema: *390 examples: default: value: @@ -52537,10 +54146,10 @@ paths: operationId: migrations/download-archive-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#download-an-organization-migration-archive parameters: - *87 - - *387 + - *391 responses: '302': description: Response @@ -52559,10 +54168,10 @@ paths: operationId: migrations/delete-archive-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - *87 - - *387 + - *391 responses: '204': description: Response @@ -52576,18 +54185,18 @@ paths: delete: summary: Unlock an organization repository description: Unlocks a repository that was locked for migration. You should - unlock each migrated repository and [delete them](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository) + unlock each migrated repository and [delete them](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. tags: - migrations operationId: migrations/unlock-repo-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#unlock-an-organization-repository parameters: - *87 - - *387 - - &809 + - *391 + - &813 name: repo_name description: repo_name parameter in: path @@ -52612,10 +54221,10 @@ paths: operationId: migrations/list-repos-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - *87 - - *387 + - *391 - *17 - *19 responses: @@ -52627,7 +54236,7 @@ paths: type: array items: *278 examples: - default: &397 + default: &401 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -52751,14 +54360,14 @@ paths: get: summary: List organization fine-grained permissions for an organization description: |- - Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." + - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -52766,7 +54375,7 @@ paths: operationId: orgs/list-organization-fine-grained-permissions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization parameters: - *87 responses: @@ -52807,12 +54416,12 @@ paths: get: summary: Get all organization roles for an organization description: |- - Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." + - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -52820,7 +54429,7 @@ paths: operationId: orgs/list-org-roles externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-all-organization-roles-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - *87 responses: @@ -52838,7 +54447,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &388 + items: &392 title: Organization Role description: Organization roles type: object @@ -52976,7 +54585,7 @@ paths: description: |- Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization and optionally across all repositories in the organization. For - more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." To include repository permissions in an organization role, you must also include the `base_role` field, which is one of `read`, `write`, `triage`, `maintain`, or `admin` (or `none` if no base role is set). This base role provides a set of @@ -52985,12 +54594,12 @@ paths: permissions apply across all of the repositories in the organization. You do not have to include organization permissions in order to add repository permissions. - See "[List repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" for valid repository permissions. + See "[List repository permissions](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" for valid repository permissions. To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." + - An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -52998,7 +54607,7 @@ paths: operationId: orgs/create-custom-organization-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#create-a-custom-organization-role parameters: - *87 requestBody: @@ -53047,7 +54656,7 @@ paths: description: Response content: application/json: - schema: *388 + schema: *392 examples: default: value: @@ -53086,7 +54695,7 @@ paths: delete: summary: Remove all organization roles for a team description: |- - Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -53096,7 +54705,7 @@ paths: operationId: orgs/revoke-all-org-roles-team externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - *87 - *214 @@ -53112,7 +54721,7 @@ paths: put: summary: Assign an organization role to a team description: |- - Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -53122,7 +54731,7 @@ paths: operationId: orgs/assign-team-to-org-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - *87 - *214 @@ -53143,7 +54752,7 @@ paths: delete: summary: Remove an organization role from a team description: |- - Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -53153,7 +54762,7 @@ paths: operationId: orgs/revoke-org-role-team externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - *87 - *214 @@ -53170,7 +54779,7 @@ paths: delete: summary: Remove all organization roles for a user description: |- - Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -53180,7 +54789,7 @@ paths: operationId: orgs/revoke-all-org-roles-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - *87 - *140 @@ -53196,7 +54805,7 @@ paths: put: summary: Assign an organization role to a user description: |- - Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -53206,7 +54815,7 @@ paths: operationId: orgs/assign-user-to-org-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - *87 - *140 @@ -53228,7 +54837,7 @@ paths: delete: summary: Remove an organization role from a user description: |- - Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -53238,7 +54847,7 @@ paths: operationId: orgs/revoke-org-role-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - *87 - *140 @@ -53255,12 +54864,12 @@ paths: get: summary: Get an organization role description: |- - Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." + - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -53268,7 +54877,7 @@ paths: operationId: orgs/get-org-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#get-an-organization-role parameters: - *87 - *139 @@ -53277,7 +54886,7 @@ paths: description: Response content: application/json: - schema: *388 + schema: *392 examples: default: value: @@ -53314,7 +54923,7 @@ paths: patch: summary: Update a custom organization role description: |- - Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." If the update would add repository permissions, the `base_role` must also be set to a value besides `none`, either previously or as part of the update. @@ -53324,7 +54933,7 @@ paths: To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." + - An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -53332,7 +54941,7 @@ paths: operationId: orgs/patch-custom-organization-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#update-a-custom-organization-role parameters: - *87 - *139 @@ -53374,7 +54983,7 @@ paths: description: Response content: application/json: - schema: *388 + schema: *392 examples: default: value: @@ -53412,12 +55021,12 @@ paths: delete: summary: Delete a custom organization role. description: |- - Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." + - An organization member (or a member of a team) assigned a custom organization role that includes the **Manage custom organization roles** (`write_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -53425,7 +55034,7 @@ paths: operationId: orgs/delete-custom-organization-role externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#delete-a-custom-organization-role parameters: - *87 - *139 @@ -53441,7 +55050,7 @@ paths: get: summary: List teams that are assigned to an organization role description: |- - Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." To use this endpoint, you must be an administrator for the organization. @@ -53451,7 +55060,7 @@ paths: operationId: orgs/list-org-role-teams externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - *87 - *139 @@ -53533,7 +55142,7 @@ paths: parent: anyOf: - type: 'null' - - *389 + - *393 type: description: The ownership type of the team type: string @@ -53566,7 +55175,7 @@ paths: - type - parent examples: - default: *390 + default: *394 headers: Link: *45 '404': @@ -53583,7 +55192,7 @@ paths: get: summary: List users that are assigned to an organization role description: |- - Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." To use this endpoint, you must be an administrator for the organization. @@ -53593,7 +55202,7 @@ paths: operationId: orgs/list-org-role-users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - *87 - *139 @@ -53625,7 +55234,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *389 + items: *393 name: type: - string @@ -53764,14 +55373,14 @@ paths: operationId: orgs/list-outside-collaborators externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - *87 - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only outside collaborators - with [insecure 2FA methods](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) + with [insecure 2FA methods](https://docs.github.com/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. in: query required: false @@ -53807,16 +55416,16 @@ paths: description: When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more - information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-cloud@latest//articles/converting-an-organization-member-to-an-outside-collaborator/)". + information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-cloud@latest/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository - management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." tags: - orgs operationId: orgs/convert-member-to-outside-collaborator externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - *87 - *140 @@ -53858,7 +55467,7 @@ paths: description: Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "[Enforcing - repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." '404': *6 x-github: githubCloudOnly: false @@ -53874,7 +55483,7 @@ paths: operationId: orgs/remove-outside-collaborator externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - *87 - *140 @@ -53897,7 +55506,7 @@ paths: value: message: You cannot specify an organization member to remove as an outside collaborator. - documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization + documentation_url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53909,13 +55518,13 @@ paths: description: |- Lists packages in an organization readable by the user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/list-packages-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-packages-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-packages-for-an-organization parameters: - name: package_type description: The type of supported package. Packages in GitHub's Gradle registry @@ -53935,13 +55544,13 @@ paths: - nuget - container - *87 - - &810 + - &814 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. - For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." in: query required: false schema: @@ -53952,14 +55561,14 @@ paths: - internal - name: page description: The page number of the results to fetch. For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 1 - name: per_page description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -53971,12 +55580,12 @@ paths: application/json: schema: type: array - items: *391 + items: *395 examples: - default: *392 + default: *396 '403': *27 '401': *23 - '400': &812 + '400': &816 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -53990,15 +55599,15 @@ paths: description: |- Gets a specific package in an organization. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-for-an-organization parameters: - - &393 + - &397 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -54016,7 +55625,7 @@ paths: - docker - nuget - container - - &394 + - &398 name: package_name description: The name of the package. in: path @@ -54029,7 +55638,7 @@ paths: description: Response content: application/json: - schema: *391 + schema: *395 examples: default: value: @@ -54071,18 +55680,18 @@ paths: description: |- Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. - The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *393 - - *394 + - *397 + - *398 - *87 responses: '204': @@ -54105,18 +55714,18 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *393 - - *394 + - *397 + - *398 - *87 - name: token description: package token @@ -54141,16 +55750,16 @@ paths: description: |- Lists package versions for a package owned by an organization. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-all-package-versions-for-package-owned-by-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *393 - - *394 + - *397 + - *398 - *87 - *19 - *17 @@ -54171,7 +55780,7 @@ paths: application/json: schema: type: array - items: &395 + items: &399 title: Package Version description: A version of a software package type: object @@ -54298,18 +55907,18 @@ paths: description: |- Gets a specific package version in an organization. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-version-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *393 - - *394 + - *397 + - *398 - *87 - - &396 + - &400 name: package_version_id description: Unique identifier of the package version. in: path @@ -54321,7 +55930,7 @@ paths: description: Response content: application/json: - schema: *395 + schema: *399 examples: default: value: @@ -54347,20 +55956,20 @@ paths: description: |- Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. - The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-version-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *393 - - *394 + - *397 + - *398 - *87 - - *396 + - *400 responses: '204': description: Response @@ -54382,20 +55991,20 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-version-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *393 - - *394 + - *397 + - *398 - *87 - - *396 + - *400 responses: '204': description: Response @@ -54420,12 +56029,12 @@ paths: operationId: orgs/list-pat-grant-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - *87 - *17 - *19 - - &398 + - &402 name: sort description: The property by which to sort the results. in: query @@ -54436,7 +56045,7 @@ paths: - created_at default: created_at - *110 - - &399 + - &403 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -54448,7 +56057,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &400 + - &404 name: repository description: The name of the repository to use to filter the results. in: query @@ -54457,7 +56066,7 @@ paths: type: string examples: - Hello-World - - &401 + - &405 name: permission description: The permission to use to filter the results. in: query @@ -54466,7 +56075,7 @@ paths: type: string examples: - issues_read - - &402 + - &406 name: last_used_before description: 'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -54476,7 +56085,7 @@ paths: schema: type: string format: date-time - - &403 + - &407 name: last_used_after description: 'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -54486,7 +56095,7 @@ paths: schema: type: string format: date-time - - &404 + - &408 name: token_id description: The ID of the token in: query @@ -54652,7 +56261,7 @@ paths: operationId: orgs/review-pat-grant-requests-in-bulk externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - *87 requestBody: @@ -54719,7 +56328,7 @@ paths: operationId: orgs/review-pat-grant-request externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - *87 - name: pat_request_id @@ -54781,7 +56390,7 @@ paths: operationId: orgs/list-pat-grant-request-repositories externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - *87 - name: pat_request_id @@ -54805,7 +56414,7 @@ paths: type: array items: *278 examples: - default: *397 + default: *401 headers: Link: *45 x-github: @@ -54826,19 +56435,19 @@ paths: operationId: orgs/list-pat-grants externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - *87 - *17 - *19 - - *398 - - *110 - - *399 - - *400 - - *401 - *402 + - *110 - *403 - *404 + - *405 + - *406 + - *407 + - *408 responses: '500': *38 '422': *15 @@ -54987,7 +56596,7 @@ paths: operationId: orgs/update-pat-accesses externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - *87 requestBody: @@ -55047,7 +56656,7 @@ paths: operationId: orgs/update-pat-access externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - *87 - name: pat_id @@ -55099,7 +56708,7 @@ paths: operationId: orgs/list-pat-grant-repositories externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - *87 - name: pat_id @@ -55122,7 +56731,7 @@ paths: type: array items: *278 examples: - default: *397 + default: *401 headers: Link: *45 x-github: @@ -55144,7 +56753,7 @@ paths: operationId: private-registries/list-org-private-registries externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#list-private-registries-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - *87 - *17 @@ -55164,7 +56773,7 @@ paths: type: integer configurations: type: array - items: &405 + items: &409 title: Organization private registry description: Private registry configuration for an organization type: object @@ -55308,7 +56917,7 @@ paths: summary: Create a private registry for an organization description: |2- - Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -55317,7 +56926,7 @@ paths: operationId: private-registries/create-org-private-registry externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - *87 requestBody: @@ -55369,7 +56978,7 @@ paths: encrypted_value: description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries - public key for an organization](https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) + public key for an organization](https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. Required when `auth_type` is `token` or `username_password`. Should be omitted for OIDC auth types. type: string @@ -55394,7 +57003,7 @@ paths: private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry - for an organization](https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) + for an organization](https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. type: array @@ -55641,7 +57250,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &406 + org-private-registry-with-selected-visibility: &410 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -55680,7 +57289,7 @@ paths: operationId: private-registries/get-org-public-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization parameters: - *87 responses: @@ -55730,7 +57339,7 @@ paths: operationId: private-registries/get-org-private-registry externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - *87 - *288 @@ -55739,9 +57348,9 @@ paths: description: The specified private registry configuration for the organization content: application/json: - schema: *405 + schema: *409 examples: - default: *406 + default: *410 '404': *6 x-github: githubCloudOnly: false @@ -55752,7 +57361,7 @@ paths: summary: Update a private registry for an organization description: |2- - Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -55761,7 +57370,7 @@ paths: operationId: private-registries/update-org-private-registry externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - *87 - *288 @@ -55814,7 +57423,7 @@ paths: encrypted_value: description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries - public key for an organization](https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) + public key for an organization](https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. type: string pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" @@ -55939,7 +57548,7 @@ paths: operationId: private-registries/delete-org-private-registry externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - *87 - *288 @@ -55963,7 +57572,7 @@ paths: operationId: projects/list-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/projects#list-projects-for-organization parameters: - *87 - name: q @@ -55982,7 +57591,7 @@ paths: application/json: schema: type: array - items: &407 + items: &411 title: Projects v2 Project description: A projects v2 project type: object @@ -56056,7 +57665,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &898 + - &903 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -56141,7 +57750,7 @@ paths: - deleted_at - deleted_by examples: - default: &408 + default: &412 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -56242,9 +57851,9 @@ paths: operationId: projects/get-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/projects#get-project-for-organization parameters: - - &409 + - &413 name: project_number description: The project's number. in: path @@ -56257,9 +57866,9 @@ paths: description: Response content: application/json: - schema: *407 + schema: *411 examples: - default: *408 + default: *412 headers: Link: *45 '304': *35 @@ -56279,10 +57888,10 @@ paths: operationId: projects/create-draft-item-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/drafts#create-draft-item-for-organization-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - *87 - - *409 + - *413 requestBody: required: true description: Details of the draft item to create in the project. @@ -56316,7 +57925,7 @@ paths: description: Response content: application/json: - schema: &414 + schema: &418 title: Projects v2 Item description: An item belonging to a project type: object @@ -56330,7 +57939,7 @@ paths: content: oneOf: - *219 - - &579 + - &583 title: Pull Request Simple description: Pull Request Simple type: object @@ -56450,7 +58059,7 @@ paths: milestone: anyOf: - type: 'null' - - *410 + - *414 active_lock_reason: type: - string @@ -56543,7 +58152,7 @@ paths: _links: type: object properties: - comments: &411 + comments: &415 title: Link description: Hypermedia Link type: object @@ -56552,13 +58161,13 @@ paths: type: string required: - href - commits: *411 - statuses: *411 - html: *411 - issue: *411 - review_comments: *411 - review_comment: *411 - self: *411 + commits: *415 + statuses: *415 + html: *415 + issue: *415 + review_comments: *415 + review_comment: *415 + self: *415 required: - comments - commits @@ -56569,7 +58178,7 @@ paths: - review_comment - self author_association: *216 - auto_merge: &694 + auto_merge: &698 title: Auto merge description: The status of auto merging a pull request. type: @@ -56671,7 +58280,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: &413 + content_type: &417 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -56715,7 +58324,7 @@ paths: - updated_at - archived_at examples: - draft_issue: &415 + draft_issue: &419 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -56787,9 +58396,9 @@ paths: operationId: projects/list-fields-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#list-project-fields-for-organization parameters: - - *409 + - *413 - *87 - *17 - *108 @@ -56801,7 +58410,7 @@ paths: application/json: schema: type: array - items: &412 + items: &416 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -56954,7 +58563,7 @@ paths: - updated_at - project_url examples: - default: &831 + default: &836 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -57082,9 +58691,9 @@ paths: operationId: projects/add-field-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-a-field-to-an-organization-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#add-a-field-to-an-organization-owned-project parameters: - - *409 + - *413 - *87 requestBody: required: true @@ -57131,7 +58740,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &832 + items: &837 type: object properties: name: @@ -57168,7 +58777,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &833 + iteration_configuration: &838 type: object description: The configuration for iteration fields. properties: @@ -57218,7 +58827,7 @@ paths: value: name: Due date data_type: date - single_select_field: &834 + single_select_field: &839 summary: Create a single select field value: name: Priority @@ -57245,7 +58854,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &835 + iteration_field: &840 summary: Create an iteration field value: name: Sprint @@ -57269,9 +58878,9 @@ paths: description: Response for adding a field to an organization-owned project. content: application/json: - schema: *412 + schema: *416 examples: - text_field: &836 + text_field: &841 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -57280,7 +58889,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-05-15T08:00:00Z' updated_at: '2022-05-15T08:00:00Z' - number_field: &837 + number_field: &842 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -57289,7 +58898,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-01T14:30:00Z' updated_at: '2022-06-01T14:30:00Z' - date_field: &838 + date_field: &843 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -57298,7 +58907,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-10T09:15:00Z' updated_at: '2022-06-10T09:15:00Z' - single_select_field: &839 + single_select_field: &844 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -57332,7 +58941,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &840 + iteration_field: &845 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -57375,10 +58984,10 @@ paths: operationId: projects/get-field-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#get-project-field-for-organization parameters: - - *409 - - &841 + - *413 + - &846 name: field_id description: The unique identifier of the field. in: path @@ -57391,9 +59000,9 @@ paths: description: Response content: application/json: - schema: *412 + schema: *416 examples: - default: &842 + default: &847 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -57447,12 +59056,12 @@ paths: operationId: projects/list-items-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-an-organization-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *409 + - *413 - *87 - name: q - description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) + description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. in: query required: false @@ -57482,7 +59091,7 @@ paths: application/json: schema: type: array - items: &416 + items: &420 title: Projects v2 Item description: An item belonging to a project type: object @@ -57499,7 +59108,7 @@ paths: description: The API URL of the project that contains this item. examples: - https://api.github.com/users/monalisa/2/projectsV2/3 - content_type: *413 + content_type: *417 content: type: - object @@ -57549,7 +59158,7 @@ paths: - updated_at - archived_at examples: - default: &417 + default: &421 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -58244,10 +59853,10 @@ paths: operationId: projects/add-item-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-organization-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#add-item-to-organization-owned-project parameters: - *87 - - *409 + - *413 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -58317,22 +59926,22 @@ paths: description: Response content: application/json: - schema: *414 + schema: *418 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *415 + value: *419 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *415 + value: *419 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *415 + value: *419 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *415 + value: *419 '304': *35 '403': *27 '401': *23 @@ -58350,11 +59959,11 @@ paths: operationId: projects/get-org-item externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-an-organization-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *409 + - *413 - *87 - - &418 + - &422 name: item_id description: The unique identifier of the project item. in: path @@ -58380,9 +59989,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *420 examples: - default: *417 + default: *421 headers: Link: *45 '304': *35 @@ -58401,11 +60010,11 @@ paths: operationId: projects/update-item-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#update-project-item-for-organization parameters: - - *409 + - *413 - *87 - - *418 + - *422 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -58478,13 +60087,13 @@ paths: description: Response content: application/json: - schema: *416 + schema: *420 examples: - text_field: *417 - number_field: *417 - date_field: *417 - single_select_field: *417 - iteration_field: *417 + text_field: *421 + number_field: *421 + date_field: *421 + single_select_field: *421 + iteration_field: *421 '401': *23 '403': *27 '404': *6 @@ -58502,11 +60111,11 @@ paths: operationId: projects/delete-item-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#delete-project-item-for-organization parameters: - - *409 + - *413 - *87 - - *418 + - *422 responses: '204': description: Response @@ -58527,10 +60136,10 @@ paths: operationId: projects/create-view-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/views#create-a-view-for-an-organization-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/views#create-a-view-for-an-organization-owned-project parameters: - *87 - - *409 + - *413 requestBody: required: true content: @@ -58554,7 +60163,7 @@ paths: - board filter: type: string - description: The filter query for the view. See [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) + description: The filter query for the view. See [Filtering projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. examples: - is:issue is:open @@ -58604,7 +60213,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &823 + schema: &827 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -58708,7 +60317,7 @@ paths: examples: table_view: summary: Response for creating a table view - value: &419 + value: &423 value: id: 1 number: 1 @@ -58754,10 +60363,10 @@ paths: - 456 board_view: summary: Response for creating a board view with filter - value: *419 + value: *423 roadmap_view: summary: Response for creating a roadmap view - value: *419 + value: *423 '304': *35 '403': *27 '401': *23 @@ -58783,11 +60392,11 @@ paths: operationId: projects/list-view-items-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-an-organization-project-view + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#list-items-for-an-organization-project-view parameters: - - *409 + - *413 - *87 - - &843 + - &848 name: view_number description: The number that identifies the project view. in: path @@ -58819,9 +60428,9 @@ paths: application/json: schema: type: array - items: *416 + items: *420 examples: - default: *417 + default: *421 headers: Link: *45 '304': *35 @@ -58844,7 +60453,7 @@ paths: operationId: orgs/custom-properties-for-repos-get-organization-definitions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-all-custom-properties-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - *87 responses: @@ -58881,7 +60490,7 @@ paths: operationId: orgs/custom-properties-for-repos-create-or-update-organization-definitions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - *87 requestBody: @@ -58945,7 +60554,7 @@ paths: operationId: orgs/custom-properties-for-repos-get-organization-definition externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-a-custom-property-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - *87 - *150 @@ -58977,7 +60586,7 @@ paths: operationId: orgs/custom-properties-for-repos-create-or-update-organization-definition externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - *87 - *150 @@ -58985,7 +60594,7 @@ paths: required: true content: application/json: - schema: *420 + schema: *424 examples: default: value: @@ -59024,7 +60633,7 @@ paths: operationId: orgs/custom-properties-for-repos-delete-organization-definition externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#remove-a-custom-property-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - *87 - *150 @@ -59048,7 +60657,7 @@ paths: operationId: orgs/custom-properties-for-repos-get-organization-values externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - *87 - *17 @@ -59058,8 +60667,8 @@ paths: one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To - learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). - See "[Searching for repositories](https://docs.github.com/enterprise-cloud@latest//articles/searching-for-repositories/)" + learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). + See "[Searching for repositories](https://docs.github.com/enterprise-cloud@latest/articles/searching-for-repositories/)" for a detailed list of qualifiers. in: query required: false @@ -59138,7 +60747,7 @@ paths: operationId: orgs/custom-properties-for-repos-create-or-update-organization-values externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - *87 requestBody: @@ -59199,7 +60808,7 @@ paths: operationId: orgs/list-public-members externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-public-organization-members parameters: - *87 - *17 @@ -59230,7 +60839,7 @@ paths: operationId: orgs/check-public-membership-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-public-organization-membership-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#check-public-organization-membership-for-a-user parameters: - *87 - *140 @@ -59249,13 +60858,13 @@ paths: description: |- The user can publicize their own membership. (A user cannot publicize the membership for another user.) - Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - orgs operationId: orgs/set-public-membership-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-public-organization-membership-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - *87 - *140 @@ -59277,7 +60886,7 @@ paths: operationId: orgs/remove-public-membership-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - *87 - *140 @@ -59296,13 +60905,13 @@ paths: Lists repositories for the specified organization. > [!NOTE] - > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." tags: - repos operationId: repos/list-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-organization-repositories parameters: - *87 - name: type @@ -59353,7 +60962,7 @@ paths: type: array items: *278 examples: - default: *397 + default: *401 headers: Link: *45 x-github: @@ -59372,7 +60981,7 @@ paths: operationId: repos/create-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-an-organization-repository parameters: - *87 requestBody: @@ -59449,7 +61058,7 @@ paths: license_template: type: string description: Choose an [open source license template](https://choosealicense.com/) - that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-cloud@latest//articles/licensing-a-repository/#searching-github-by-license-type) + that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-cloud@latest/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". allow_squash_merge: type: boolean @@ -59557,7 +61166,7 @@ paths: description: Response content: application/json: - schema: &466 + schema: &470 title: Full Repository description: Full Repository type: object @@ -60035,7 +61644,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &584 + code_of_conduct: &588 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -60065,7 +61674,7 @@ paths: - key - name - html_url - security_and_analysis: *421 + security_and_analysis: *425 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -60149,7 +61758,7 @@ paths: - network_count - subscribers_count examples: - default: &468 + default: &472 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -60655,7 +62264,7 @@ paths: get: summary: List repository fine-grained permissions for an organization description: |- - Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. @@ -60665,7 +62274,7 @@ paths: operationId: orgs/list-repo-fine-grained-permissions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization parameters: - *87 responses: @@ -60675,9 +62284,9 @@ paths: application/json: schema: type: array - items: *422 + items: *426 examples: - default: *423 + default: *427 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -60692,7 +62301,7 @@ paths: operationId: repos/get-org-rulesets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-all-organization-repository-rulesets + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#get-all-organization-repository-rulesets x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60702,7 +62311,7 @@ paths: - *87 - *17 - *19 - - &716 + - &720 name: targets description: | A comma-separated list of rule targets to filter by. @@ -60761,7 +62370,7 @@ paths: operationId: repos/create-org-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#create-an-organization-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#create-an-organization-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60794,11 +62403,11 @@ paths: type: array description: The actors that can bypass the rules in this ruleset items: *165 - conditions: *424 + conditions: *428 rules: type: array description: An array of rules within the ruleset. - items: &426 + items: &430 title: Repository Rule type: object description: A repository rule. @@ -60863,7 +62472,7 @@ paths: application/json: schema: *187 examples: - default: &425 + default: &429 value: id: 21 name: super cool ruleset @@ -60910,16 +62519,16 @@ paths: summary: List organization rule suites description: |- Lists suites of rule evaluations at the organization level. - For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." tags: - repos operationId: repos/get-org-rule-suites externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *87 - - &718 + - &722 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -60931,14 +62540,14 @@ paths: x-multi-segment: true - *304 - *105 - - &719 + - &723 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &720 + - &724 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -60958,7 +62567,7 @@ paths: description: Response content: application/json: - schema: &721 + schema: &725 title: Rule Suites description: Response type: array @@ -61014,7 +62623,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &722 + default: &726 value: - id: 21 actor_id: 12 @@ -61049,21 +62658,21 @@ paths: summary: Get an organization rule suite description: |- Gets information about a suite of rule evaluations from within an organization. - For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." tags: - repos operationId: repos/get-org-rule-suite externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *87 - - &723 + - &727 name: rule_suite_id description: |- The unique identifier of the rule suite result. - To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites) - for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites) + To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#list-repository-rule-suites) + for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#list-organization-rule-suites) for organizations. in: path required: true @@ -61074,7 +62683,7 @@ paths: description: Response content: application/json: - schema: &724 + schema: &728 title: Rule Suite description: Response type: object @@ -61181,7 +62790,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &725 + default: &729 value: id: 21 actor_id: 12 @@ -61235,7 +62844,7 @@ paths: operationId: repos/get-org-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-an-organization-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#get-an-organization-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61256,7 +62865,7 @@ paths: application/json: schema: *187 examples: - default: *425 + default: *429 '404': *6 '500': *38 put: @@ -61267,7 +62876,7 @@ paths: operationId: repos/update-org-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#update-an-organization-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#update-an-organization-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61305,11 +62914,11 @@ paths: type: array description: The actors that can bypass the rules in this ruleset items: *165 - conditions: *424 + conditions: *428 rules: description: An array of rules within the ruleset. type: array - items: *426 + items: *430 examples: default: value: @@ -61346,7 +62955,7 @@ paths: application/json: schema: *187 examples: - default: *425 + default: *429 '404': *6 '422': *15 '500': *38 @@ -61358,7 +62967,7 @@ paths: operationId: repos/delete-org-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#delete-an-organization-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#delete-an-organization-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61386,7 +62995,7 @@ paths: operationId: orgs/get-org-ruleset-history externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-history + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#get-organization-ruleset-history parameters: - *87 - *17 @@ -61406,7 +63015,7 @@ paths: type: array items: *191 examples: - default: *427 + default: *431 '404': *6 '500': *38 x-github: @@ -61423,7 +63032,7 @@ paths: operationId: orgs/get-org-ruleset-version externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-version + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules#get-organization-ruleset-version parameters: - *87 - name: ruleset_id @@ -61443,7 +63052,7 @@ paths: description: Response content: application/json: - schema: *428 + schema: *432 examples: default: value: @@ -61503,23 +63112,23 @@ paths: operationId: secret-scanning/list-alerts-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *87 - - *429 - - *430 - - *431 - - *432 - *433 - *434 - *435 - *436 + - *437 + - *438 + - *439 + - *440 - *110 - *19 - *17 - - &727 + - &731 name: before - description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. @@ -61527,9 +63136,9 @@ paths: required: false schema: type: string - - &728 + - &732 name: after - description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. @@ -61537,10 +63146,10 @@ paths: required: false schema: type: string - - *437 - - *438 - - *439 - - *440 + - *441 + - *442 + - *443 + - *444 responses: '200': description: Response @@ -61548,9 +63157,9 @@ paths: application/json: schema: type: array - items: *441 + items: *445 examples: - default: *442 + default: *446 headers: Link: *45 '404': *6 @@ -61572,7 +63181,7 @@ paths: operationId: secret-scanning/list-org-pattern-configs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-organization-pattern-configurations + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/push-protection#list-organization-pattern-configurations x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61585,9 +63194,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *447 examples: - default: *444 + default: *448 '403': *27 '404': *6 patch: @@ -61601,7 +63210,7 @@ paths: operationId: secret-scanning/update-org-pattern-configs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-organization-pattern-configurations + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/push-protection#update-organization-pattern-configurations x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61694,7 +63303,7 @@ paths: operationId: security-advisories/list-org-repository-advisories externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - *87 - *110 @@ -61713,7 +63322,7 @@ paths: - *109 - name: per_page description: The number of advisories to return per page. For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: @@ -61740,7 +63349,7 @@ paths: application/json: schema: type: array - items: &749 + items: &753 description: A repository security advisory. type: object properties: @@ -61984,7 +63593,7 @@ paths: login: type: string description: The username of the user credited. - type: *445 + type: *449 credits_detailed: type: - array @@ -61995,7 +63604,7 @@ paths: type: object properties: user: *4 - type: *445 + type: *449 state: type: string description: The state of the user's acceptance of the @@ -62059,7 +63668,7 @@ paths: - private_fork additionalProperties: false examples: - default: &750 + default: &754 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -62430,13 +64039,13 @@ paths: summary: List security manager teams description: |- > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)" endpoints instead. + > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles)" endpoints instead. tags: - orgs operationId: orgs/list-security-manager-teams externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/security-managers#list-security-manager-teams parameters: - *87 responses: @@ -62446,7 +64055,7 @@ paths: application/json: schema: type: array - items: *389 + items: *393 examples: default: value: @@ -62478,13 +64087,13 @@ paths: summary: Add a security manager team description: |- > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)" endpoints instead. + > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles)" endpoints instead. tags: - orgs operationId: orgs/add-security-manager-team externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/security-managers#add-a-security-manager-team parameters: - *87 - *214 @@ -62504,13 +64113,13 @@ paths: summary: Remove a security manager team description: |- > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)" endpoints instead. + > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/enterprise-cloud@latest/rest/orgs/organization-roles)" endpoints instead. tags: - orgs operationId: orgs/remove-security-manager-team externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/security-managers#remove-a-security-manager-team parameters: - *87 - *214 @@ -62542,10 +64151,10 @@ paths: operationId: billing/get-github-advanced-security-billing-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - *87 - - *446 + - *450 - *17 - *19 responses: @@ -62553,9 +64162,9 @@ paths: description: Success content: application/json: - schema: *447 + schema: *451 examples: - default: *448 + default: *452 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -62573,7 +64182,7 @@ paths: operationId: orgs/get-immutable-releases-settings externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-immutable-releases-settings-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization parameters: - *87 responses: @@ -62623,7 +64232,7 @@ paths: operationId: orgs/set-immutable-releases-settings externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#set-immutable-releases-settings-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization parameters: - *87 responses: @@ -62652,9 +64261,9 @@ paths: enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable - a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) + a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an - organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) + organization](https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. items: type: integer @@ -62681,7 +64290,7 @@ paths: operationId: orgs/get-immutable-releases-settings-repositories externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement parameters: - *87 - *19 @@ -62720,7 +64329,7 @@ paths: operationId: orgs/set-immutable-releases-settings-repositories externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement parameters: - *87 requestBody: @@ -62736,9 +64345,9 @@ paths: enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable - a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) + a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an - organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) + organization](https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. items: type: integer @@ -62769,7 +64378,7 @@ paths: - orgs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *87 - *272 @@ -62792,7 +64401,7 @@ paths: - orgs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *87 - *272 @@ -62816,7 +64425,7 @@ paths: operationId: hosted-compute/list-network-configurations-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - *87 - *17 @@ -62838,7 +64447,7 @@ paths: type: array items: *145 examples: - default: *449 + default: *453 headers: Link: *45 x-github: @@ -62857,7 +64466,7 @@ paths: operationId: hosted-compute/create-network-configuration-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization parameters: - *87 requestBody: @@ -62935,7 +64544,7 @@ paths: operationId: hosted-compute/get-network-configuration-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - *87 - *147 @@ -62965,7 +64574,7 @@ paths: operationId: hosted-compute/update-network-configuration-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - *87 - *147 @@ -63040,7 +64649,7 @@ paths: operationId: hosted-compute/delete-network-configuration-from-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - *87 - *147 @@ -63064,18 +64673,18 @@ paths: operationId: hosted-compute/get-network-settings-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - *87 - - *450 + - *454 responses: '200': description: Response content: application/json: - schema: *451 + schema: *455 examples: - default: *452 + default: *456 headers: Link: *45 x-github: @@ -63092,7 +64701,7 @@ paths: operationId: teams/list-idp-groups-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#list-idp-groups-for-an-organization parameters: - *87 - *17 @@ -63113,7 +64722,7 @@ paths: description: Response content: application/json: - schema: &463 + schema: &467 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -63165,7 +64774,7 @@ paths: group_description: Another group of Developers working on AzureAD SAML SSO examples: - default: &464 + default: &468 value: groups: - group_id: '123' @@ -63208,7 +64817,7 @@ paths: operationId: copilot/copilot-metrics-for-team externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - *87 - *214 @@ -63231,7 +64840,7 @@ paths: - *19 - name: per_page description: The number of days of metrics to display per page (max 100). - For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer @@ -63265,14 +64874,14 @@ paths: operationId: teams/list externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-teams parameters: - *87 - *17 - *19 - name: team_type description: Filter team results by their type. For more information, see - "[What kind of team should I use?](https://docs.github.com/enterprise-cloud@latest//enterprise-cloud@latest/admin/concepts/enterprise-fundamentals/teams-in-an-enterprise#what-kind-of-team-should-i-use)" + "[What kind of team should I use?](https://docs.github.com/enterprise-cloud@latest/enterprise-cloud@latest/admin/concepts/enterprise-fundamentals/teams-in-an-enterprise#what-kind-of-team-should-i-use)" in: query required: false schema: @@ -63291,7 +64900,7 @@ paths: type: array items: *307 examples: - default: *390 + default: *394 headers: Link: *45 '403': *27 @@ -63303,15 +64912,15 @@ paths: post: summary: Create a team description: |- - To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/enterprise-cloud@latest//articles/setting-team-creation-permissions-in-your-organization)." + To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/enterprise-cloud@latest/articles/setting-team-creation-permissions-in-your-organization)." - When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/about-teams)". + When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/about-teams)". tags: - teams operationId: teams/create externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#create-a-team parameters: - *87 requestBody: @@ -63385,7 +64994,7 @@ paths: description: Response content: application/json: - schema: &453 + schema: &457 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -63459,7 +65068,7 @@ paths: parent: anyOf: - type: 'null' - - *389 + - *393 members_count: type: integer examples: @@ -63784,7 +65393,7 @@ paths: - repos_count - organization examples: - default: &454 + default: &458 value: id: 1 node_id: MDQ6VGVhbTE= @@ -63852,7 +65461,7 @@ paths: operationId: teams/get-by-name externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#get-a-team-by-name parameters: - *87 - *214 @@ -63861,9 +65470,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *457 examples: - default: *454 + default: *458 '404': *6 x-github: githubCloudOnly: false @@ -63882,7 +65491,7 @@ paths: operationId: teams/update-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#update-a-team parameters: - *87 - *214 @@ -63948,16 +65557,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *453 + schema: *457 examples: - default: *454 + default: *458 '201': description: Response content: application/json: - schema: *453 + schema: *457 examples: - default: *454 + default: *458 '404': *6 '422': *15 '403': *27 @@ -63980,14 +65589,14 @@ paths: operationId: teams/delete-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#delete-a-team parameters: - *87 - *214 responses: '204': description: Response - '422': &457 + '422': &461 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -64001,13 +65610,13 @@ paths: description: |- Lists a connection between a team and an external group. - You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. tags: - teams operationId: teams/list-linked-external-idp-groups-to-team-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team parameters: - *87 - *214 @@ -64016,10 +65625,10 @@ paths: description: Response content: application/json: - schema: *455 + schema: *459 examples: - default: *456 - '422': *457 + default: *460 + '422': *461 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -64030,13 +65639,13 @@ paths: description: |- Creates a connection between a team and an external group. Only one external group can be linked to a team. - You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. tags: - teams operationId: teams/link-external-idp-group-to-team-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team parameters: - *87 - *214 @@ -64063,10 +65672,10 @@ paths: description: Response content: application/json: - schema: *458 + schema: *462 examples: - default: *459 - '422': *457 + default: *463 + '422': *461 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -64077,20 +65686,20 @@ paths: description: |- Deletes a connection between a team and an external group. - You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - teams operationId: teams/unlink-external-idp-group-from-team-for-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team parameters: - *87 - *214 responses: '204': description: Response - '422': *457 + '422': *461 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -64109,7 +65718,7 @@ paths: operationId: teams/list-pending-invitations-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-pending-team-invitations parameters: - *87 - *214 @@ -64122,12 +65731,12 @@ paths: application/json: schema: type: array - items: *370 + items: *374 examples: - default: *371 + default: *375 headers: Link: *45 - '422': *457 + '422': *461 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64145,7 +65754,7 @@ paths: operationId: teams/list-members-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-team-members parameters: - *87 - *214 @@ -64193,13 +65802,13 @@ paths: > [!NOTE] > The response contains the `state` of the membership and the member's `role`. - The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team). + The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#create-a-team). tags: - teams operationId: teams/get-membership-for-user-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-membership-for-a-user parameters: - *87 - *214 @@ -64209,7 +65818,7 @@ paths: description: Response content: application/json: - schema: &460 + schema: &464 title: Team Membership description: Team Membership type: object @@ -64237,7 +65846,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &791 + response-if-user-is-a-team-maintainer: &795 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -64255,10 +65864,10 @@ paths: description: |- Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. > [!NOTE] - > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. @@ -64271,7 +65880,7 @@ paths: operationId: teams/add-or-update-membership-for-user-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-or-update-team-membership-for-a-user parameters: - *87 - *214 @@ -64300,9 +65909,9 @@ paths: description: Response content: application/json: - schema: *460 + schema: *464 examples: - response-if-users-membership-with-team-is-now-pending: &792 + response-if-users-membership-with-team-is-now-pending: &796 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -64323,10 +65932,10 @@ paths: description: |- To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. > [!NOTE] - > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. @@ -64335,7 +65944,7 @@ paths: operationId: teams/remove-membership-for-user-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-membership-for-a-user parameters: - *87 - *214 @@ -64363,7 +65972,7 @@ paths: operationId: teams/list-repos-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-team-repositories parameters: - *87 - *214 @@ -64378,7 +65987,7 @@ paths: type: array items: *278 examples: - default: *397 + default: *401 headers: Link: *45 x-github: @@ -64392,7 +66001,7 @@ paths: description: |- Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. - You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header. + You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header. If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. @@ -64405,18 +66014,18 @@ paths: operationId: teams/check-permissions-for-repo-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#check-team-permissions-for-a-repository parameters: - *87 - *214 - - *461 - - *462 + - *465 + - *466 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &793 + schema: &797 title: Team Repository description: A team's access to a repository. type: object @@ -65044,23 +66653,23 @@ paths: put: summary: Add or update team repository permissions description: |- - To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method)." > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. - For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". tags: - teams operationId: teams/add-or-update-repo-permissions-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#add-or-update-team-repository-permissions parameters: - *87 - *214 - - *461 - - *462 + - *465 + - *466 requestBody: required: false content: @@ -65103,12 +66712,12 @@ paths: operationId: teams/remove-repo-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#remove-a-repository-from-a-team parameters: - *87 - *214 - - *461 - - *462 + - *465 + - *466 responses: '204': description: Response @@ -65123,7 +66732,7 @@ paths: description: |- List IdP groups connected to a team on GitHub Enterprise Cloud. - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. @@ -65132,7 +66741,7 @@ paths: operationId: teams/list-idp-groups-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#list-idp-groups-for-a-team parameters: - *87 - *214 @@ -65141,10 +66750,10 @@ paths: description: Response content: application/json: - schema: *463 + schema: *467 examples: - default: *464 - '422': *457 + default: *468 + '422': *461 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -65155,7 +66764,7 @@ paths: description: |- Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. @@ -65164,7 +66773,7 @@ paths: operationId: teams/create-or-update-idp-group-connections-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#create-or-update-idp-group-connections parameters: - *87 - *214 @@ -65210,7 +66819,7 @@ paths: description: Response content: application/json: - schema: *463 + schema: *467 examples: default: value: @@ -65222,7 +66831,7 @@ paths: group_name: Octocat docs members group_description: The people who make your octoworld come to life. - '422': *457 + '422': *461 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -65241,7 +66850,7 @@ paths: operationId: teams/list-child-in-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-child-teams parameters: - *87 - *214 @@ -65256,7 +66865,7 @@ paths: type: array items: *307 examples: - response-if-child-teams-exist: &794 + response-if-child-teams-exist: &798 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -65295,9 +66904,9 @@ paths: summary: Enable or disable a security feature for an organization description: |- > [!WARNING] - > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). - Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. @@ -65307,7 +66916,7 @@ paths: operationId: orgs/enable-or-disable-security-product-on-all-org-repos externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - *87 - name: security_product @@ -65378,15 +66987,15 @@ paths: Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search)." - * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code)." - * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit)." - * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph)." - * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph)." - * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners)." - * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions)." + * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-cloud@latest/rest/search/search)." + * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-code)." + * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-cloud@latest/graphql/overview/resource-limitations#rate-limit)." + * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph)." + * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph)." + * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners)." + * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-cloud@latest/rest/about-the-rest-api/api-versions)." > [!NOTE] > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. @@ -65395,7 +67004,7 @@ paths: operationId: rate-limit/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user parameters: [] responses: '200': @@ -65410,7 +67019,7 @@ paths: resources: type: object properties: - core: &465 + core: &469 title: Rate Limit type: object properties: @@ -65427,21 +67036,21 @@ paths: - remaining - reset - used - graphql: *465 - search: *465 - code_search: *465 - source_import: *465 - integration_manifest: *465 - code_scanning_upload: *465 - actions_runner_registration: *465 - scim: *465 - dependency_snapshots: *465 - dependency_sbom: *465 - code_scanning_autofix: *465 + graphql: *469 + search: *469 + code_search: *469 + source_import: *469 + integration_manifest: *469 + code_scanning_upload: *469 + actions_runner_registration: *469 + scim: *469 + dependency_snapshots: *469 + dependency_sbom: *469 + code_scanning_autofix: *469 required: - core - search - rate: *465 + rate: *469 required: - rate - resources @@ -65537,23 +67146,23 @@ paths: The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. > [!NOTE] - > - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + > - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." > - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions. tags: - repos operationId: repos/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response content: application/json: - schema: *466 + schema: *470 examples: default-response: summary: Default response @@ -66062,7 +67671,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *467 + '301': *471 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66071,17 +67680,17 @@ paths: patch: summary: Update a repository description: "**Note**: To edit a repository's topics, use the [Replace all - repository topics](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics) + repository topics](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#replace-all-repository-topics) endpoint." tags: - repos operationId: repos/update externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#update-a-repository parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: false content: @@ -66103,7 +67712,7 @@ paths: description: "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository - visibility](https://docs.github.com/enterprise-cloud@latest//articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) + visibility](https://docs.github.com/enterprise-cloud@latest/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private." default: false @@ -66121,7 +67730,7 @@ paths: description: |- Specify which security and analysis features to enable or disable for the repository. - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. @@ -66171,7 +67780,7 @@ paths: description: Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see "[Responsible detection of generic secrets - with AI](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)." + with AI](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)." properties: status: type: string @@ -66390,10 +67999,10 @@ paths: description: Response content: application/json: - schema: *466 + schema: *470 examples: - default: *468 - '307': &469 + default: *472 + '307': &473 description: Temporary Redirect content: application/json: @@ -66420,10 +68029,10 @@ paths: operationId: repos/delete externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': description: Response @@ -66444,8 +68053,8 @@ paths: default: value: message: Organization members cannot delete repositories. - documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository - '307': *469 + documentation_url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository + '307': *473 '404': *6 '409': *119 x-github: @@ -66467,13 +68076,13 @@ paths: operationId: actions/list-artifacts-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 - - &486 + - &490 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -66496,7 +68105,7 @@ paths: type: integer artifacts: type: array - items: &470 + items: &474 title: Artifact description: An artifact type: object @@ -66591,7 +68200,7 @@ paths: - expires_at - updated_at examples: - default: &487 + default: &491 value: total_count: 2 artifacts: @@ -66650,11 +68259,11 @@ paths: operationId: actions/get-artifact externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#get-an-artifact parameters: - - *461 - - *462 - - &471 + - *465 + - *466 + - &475 name: artifact_id description: The unique identifier of the artifact. in: path @@ -66666,7 +68275,7 @@ paths: description: Response content: application/json: - schema: *470 + schema: *474 examples: default: value: @@ -66702,11 +68311,11 @@ paths: operationId: actions/delete-artifact externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#delete-an-artifact parameters: - - *461 - - *462 - - *471 + - *465 + - *466 + - *475 responses: '204': description: Response @@ -66728,11 +68337,11 @@ paths: operationId: actions/download-artifact externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#download-an-artifact parameters: - - *461 - - *462 - - *471 + - *465 + - *466 + - *475 - name: archive_format in: path required: true @@ -66742,11 +68351,11 @@ paths: '302': description: Response headers: - Location: &601 + Location: &605 example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': &649 + '410': &653 description: Gone content: application/json: @@ -66769,16 +68378,16 @@ paths: operationId: actions/get-actions-cache-retention-limit-for-repository externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response content: application/json: - schema: &472 + schema: &476 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -66810,15 +68419,15 @@ paths: operationId: actions/set-actions-cache-retention-limit-for-repository externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: application/json: - schema: *472 + schema: *476 examples: selected_actions: *42 responses: @@ -66845,16 +68454,16 @@ paths: operationId: actions/get-actions-cache-storage-limit-for-repository externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response content: application/json: - schema: &473 + schema: &477 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -66886,15 +68495,15 @@ paths: operationId: actions/set-actions-cache-storage-limit-for-repository externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: application/json: - schema: *473 + schema: *477 examples: selected_actions: *44 responses: @@ -66923,16 +68532,16 @@ paths: operationId: actions/get-actions-cache-usage externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response content: application/json: - schema: *474 + schema: *478 examples: default: value: @@ -66956,13 +68565,13 @@ paths: operationId: actions/get-actions-cache-list externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-github-actions-caches-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 - - &475 + - &479 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -66996,7 +68605,7 @@ paths: description: Response content: application/json: - schema: &476 + schema: &480 title: Repository actions caches description: Repository actions caches type: object @@ -67046,7 +68655,7 @@ paths: - total_count - actions_caches examples: - default: &477 + default: &481 value: total_count: 1 actions_caches: @@ -67076,25 +68685,25 @@ paths: operationId: actions/delete-actions-cache-by-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *461 - - *462 + - *465 + - *466 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *475 + - *479 responses: '200': description: Response content: application/json: - schema: *476 + schema: *480 examples: - default: *477 + default: *481 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67112,10 +68721,10 @@ paths: operationId: actions/delete-actions-cache-by-id externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *461 - - *462 + - *465 + - *466 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -67144,11 +68753,11 @@ paths: operationId: actions/get-job-for-workflow-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#get-a-job-for-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *461 - - *462 - - &478 + - *465 + - *466 + - &482 name: job_id description: The unique identifier of the job. in: path @@ -67160,7 +68769,7 @@ paths: description: Response content: application/json: - schema: &490 + schema: &494 title: Job description: Information of a job execution in a workflow run type: object @@ -67505,11 +69114,11 @@ paths: operationId: actions/download-job-logs-for-workflow-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *461 - - *462 - - *478 + - *465 + - *466 + - *482 responses: '302': description: Response @@ -67535,11 +69144,11 @@ paths: operationId: actions/re-run-job-for-workflow-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *461 - - *462 - - *478 + - *465 + - *466 + - *482 requestBody: required: false content: @@ -67583,10 +69192,10 @@ paths: operationId: actions/get-custom-oidc-sub-claim-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Status response @@ -67607,6 +69216,15 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether the repository has opted in to the immutable + OIDC subject claim format. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. If not set at the + repository level, falls back to the organization-level setting. + type: boolean + sub_claim_prefix: + description: The current `sub` claim prefix for this repository. + type: string required: - use_default examples: @@ -67634,10 +69252,10 @@ paths: operationId: actions/set-custom-oidc-sub-claim-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -67659,6 +69277,11 @@ paths: type: array items: type: string + use_immutable_subject: + description: Whether to opt in to the immutable OIDC subject claim + format for this repository. When `true`, OIDC tokens will use + a stable, repository-ID-based `sub` claim. + type: boolean examples: default: value: @@ -67698,10 +69321,10 @@ paths: operationId: actions/list-repo-organization-secrets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-repository-organization-secrets parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 responses: @@ -67719,7 +69342,7 @@ paths: type: integer secrets: type: array - items: &492 + items: &496 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -67740,7 +69363,7 @@ paths: - created_at - updated_at examples: - default: &493 + default: &497 value: total_count: 2 secrets: @@ -67771,11 +69394,11 @@ paths: operationId: actions/list-repo-organization-variables externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-repository-organization-variables parameters: - - *461 - - *462 - - *479 + - *465 + - *466 + - *483 - *19 responses: '200': @@ -67792,7 +69415,7 @@ paths: type: integer variables: type: array - items: &496 + items: &500 title: Actions Variable type: object properties: @@ -67826,7 +69449,7 @@ paths: - created_at - updated_at examples: - default: &497 + default: &501 value: total_count: 2 variables: @@ -67857,10 +69480,10 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -67869,7 +69492,7 @@ paths: schema: type: object properties: - enabled: &480 + enabled: &484 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *60 @@ -67902,10 +69525,10 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': description: Response @@ -67916,7 +69539,7 @@ paths: schema: type: object properties: - enabled: *480 + enabled: *484 allowed_actions: *60 sha_pinning_required: *61 required: @@ -67938,8 +69561,8 @@ paths: description: |- Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. This endpoint only applies to internal and private repositories. - For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and - "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." + For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and + "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: @@ -67947,16 +69570,16 @@ paths: operationId: actions/get-workflow-access-to-repository externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response content: application/json: - schema: &481 + schema: &485 type: object properties: access_level: @@ -67974,7 +69597,7 @@ paths: required: - access_level examples: - default: &482 + default: &486 value: access_level: organization x-github: @@ -67988,8 +69611,8 @@ paths: description: |- Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. This endpoint only applies to internal and private repositories. - For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and - "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." + For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and + "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: @@ -67997,17 +69620,17 @@ paths: operationId: actions/set-workflow-access-to-repository externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: application/json: - schema: *481 + schema: *485 examples: - default: *482 + default: *486 responses: '204': description: Response @@ -68029,10 +69652,10 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -68060,10 +69683,10 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': description: Empty response for successful settings update @@ -68095,10 +69718,10 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -68123,10 +69746,10 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': description: Response @@ -68158,10 +69781,10 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -68187,10 +69810,10 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -68219,10 +69842,10 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -68251,10 +69874,10 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': description: Response @@ -68276,7 +69899,7 @@ paths: description: |- Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, as well as if GitHub Actions can submit approving pull request reviews. - For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: @@ -68284,10 +69907,10 @@ paths: operationId: actions/get-github-actions-default-workflow-permissions-repository externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -68306,7 +69929,7 @@ paths: description: |- Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions can submit approving pull request reviews. - For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: @@ -68314,10 +69937,10 @@ paths: operationId: actions/set-github-actions-default-workflow-permissions-repository externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': description: Success response @@ -68350,15 +69973,15 @@ paths: operationId: actions/list-self-hosted-runners-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository parameters: - name: name description: The name of a self-hosted runner. in: query schema: type: string - - *461 - - *462 + - *465 + - *466 - *17 - *19 responses: @@ -68400,10 +70023,10 @@ paths: operationId: actions/list-runner-applications-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -68433,10 +70056,10 @@ paths: operationId: actions/generate-runner-jitconfig-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -68508,10 +70131,10 @@ paths: operationId: actions/create-registration-token-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '201': description: Response @@ -68545,10 +70168,10 @@ paths: operationId: actions/create-remove-token-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '201': description: Response @@ -68576,10 +70199,10 @@ paths: operationId: actions/get-self-hosted-runner-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 - *75 responses: '200': @@ -68607,10 +70230,10 @@ paths: operationId: actions/delete-self-hosted-runner-from-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *461 - - *462 + - *465 + - *466 - *75 responses: '204': @@ -68635,10 +70258,10 @@ paths: operationId: actions/list-labels-for-self-hosted-runner-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 - *75 responses: '200': *81 @@ -68661,10 +70284,10 @@ paths: operationId: actions/add-custom-labels-to-self-hosted-runner-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 - *75 requestBody: required: true @@ -68711,10 +70334,10 @@ paths: operationId: actions/set-custom-labels-for-self-hosted-runner-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 - *75 requestBody: required: true @@ -68762,10 +70385,10 @@ paths: operationId: actions/remove-all-custom-labels-from-self-hosted-runner-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 - *75 responses: '200': *285 @@ -68793,10 +70416,10 @@ paths: operationId: actions/remove-custom-label-from-self-hosted-runner-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 - *75 - *286 responses: @@ -68812,7 +70435,7 @@ paths: get: summary: List workflow runs for a repository description: |- - Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). + Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#parameters). Anyone with read access to the repository can use this endpoint. @@ -68824,11 +70447,11 @@ paths: operationId: actions/list-workflow-runs-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *461 - - *462 - - &500 + - *465 + - *466 + - &504 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -68836,7 +70459,7 @@ paths: required: false schema: type: string - - &501 + - &505 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -68844,16 +70467,16 @@ paths: required: false schema: type: string - - &502 + - &506 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events - that trigger workflows](https://docs.github.com/enterprise-cloud@latest//actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." + that trigger workflows](https://docs.github.com/enterprise-cloud@latest/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." in: query required: false schema: type: string - - &503 + - &507 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -68880,16 +70503,16 @@ paths: - pending - *17 - *19 - - &504 + - &508 name: created description: Returns workflow runs created within the given date-time range. - For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." in: query required: false schema: type: string format: date-time - - &483 + - &487 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -68898,13 +70521,13 @@ paths: schema: type: boolean default: false - - &505 + - &509 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &506 + - &510 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -68927,7 +70550,7 @@ paths: type: integer workflow_runs: type: array - items: &484 + items: &488 title: Workflow Run description: An invocation of a workflow type: object @@ -69105,7 +70728,7 @@ paths: head_commit: anyOf: - type: 'null' - - &528 + - &532 title: Simple Commit description: A commit. type: object @@ -69220,7 +70843,7 @@ paths: - workflow_url - pull_requests examples: - default: &507 + default: &511 value: total_count: 1 workflow_runs: @@ -69454,26 +71077,26 @@ paths: operationId: actions/get-workflow-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *461 - - *462 - - &485 + - *465 + - *466 + - &489 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *483 + - *487 responses: '200': description: Response content: application/json: - schema: *484 + schema: *488 examples: - default: &488 + default: &492 value: id: 30433642 name: Build @@ -69712,11 +71335,11 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *461 - - *462 - - *485 + - *465 + - *466 + - *489 responses: '204': description: Response @@ -69737,11 +71360,11 @@ paths: operationId: actions/get-reviews-for-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *461 - - *462 - - *485 + - *465 + - *466 + - *489 responses: '200': description: Response @@ -69859,7 +71482,7 @@ paths: post: summary: Approve a workflow run for a fork pull request description: |- - Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/enterprise-cloud@latest//actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." + Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/enterprise-cloud@latest/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: @@ -69867,11 +71490,11 @@ paths: operationId: actions/approve-workflow-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *461 - - *462 - - *485 + - *465 + - *466 + - *489 responses: '201': description: Response @@ -69902,14 +71525,14 @@ paths: operationId: actions/list-workflow-run-artifacts externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *461 - - *462 - - *485 + - *465 + - *466 + - *489 - *17 - *19 - - *486 + - *490 - *110 responses: '200': @@ -69926,9 +71549,9 @@ paths: type: integer artifacts: type: array - items: *470 + items: *474 examples: - default: *487 + default: *491 headers: Link: *45 x-github: @@ -69950,27 +71573,27 @@ paths: operationId: actions/get-workflow-run-attempt externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *461 - - *462 - - *485 - - &489 + - *465 + - *466 + - *489 + - &493 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *483 + - *487 responses: '200': description: Response content: application/json: - schema: *484 + schema: *488 examples: - default: *488 + default: *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69981,7 +71604,7 @@ paths: summary: List jobs for a workflow run attempt description: |- Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information - about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). + about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#parameters). Anyone with read access to the repository can use this endpoint. @@ -69991,12 +71614,12 @@ paths: operationId: actions/list-jobs-for-workflow-run-attempt externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *461 - - *462 - - *485 + - *465 + - *466 - *489 + - *493 - *17 - *19 responses: @@ -70014,9 +71637,9 @@ paths: type: integer jobs: type: array - items: *490 + items: *494 examples: - default: &491 + default: &495 value: total_count: 1 jobs: @@ -70127,12 +71750,12 @@ paths: operationId: actions/download-workflow-run-attempt-logs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *461 - - *462 - - *485 + - *465 + - *466 - *489 + - *493 responses: '302': description: Response @@ -70158,11 +71781,11 @@ paths: operationId: actions/cancel-workflow-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *461 - - *462 - - *485 + - *465 + - *466 + - *489 responses: '202': description: Response @@ -70182,7 +71805,7 @@ paths: post: summary: Review custom deployment protection rules for a workflow run description: |- - Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." + Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment)." > [!NOTE] > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). @@ -70193,11 +71816,11 @@ paths: operationId: actions/review-custom-gates-for-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *461 - - *462 - - *485 + - *465 + - *466 + - *489 requestBody: required: true content: @@ -70262,11 +71885,11 @@ paths: operationId: actions/force-cancel-workflow-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *461 - - *462 - - *485 + - *465 + - *466 + - *489 responses: '202': description: Response @@ -70287,7 +71910,7 @@ paths: summary: List jobs for a workflow run description: |- Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information - about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). + about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#parameters). Anyone with read access to the repository can use this endpoint. @@ -70297,11 +71920,11 @@ paths: operationId: actions/list-jobs-for-workflow-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *461 - - *462 - - *485 + - *465 + - *466 + - *489 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -70331,9 +71954,9 @@ paths: type: integer jobs: type: array - items: *490 + items: *494 examples: - default: *491 + default: *495 headers: Link: *45 x-github: @@ -70356,11 +71979,11 @@ paths: operationId: actions/download-workflow-run-logs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *461 - - *462 - - *485 + - *465 + - *466 + - *489 responses: '302': description: Response @@ -70385,11 +72008,11 @@ paths: operationId: actions/delete-workflow-run-logs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *461 - - *462 - - *485 + - *465 + - *466 + - *489 responses: '204': description: Response @@ -70414,11 +72037,11 @@ paths: operationId: actions/get-pending-deployments-for-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *461 - - *462 - - *485 + - *465 + - *466 + - *489 responses: '200': description: Response @@ -70487,7 +72110,7 @@ paths: items: type: object properties: - type: &616 + type: &620 type: string description: The type of reviewer. enum: @@ -70571,11 +72194,11 @@ paths: operationId: actions/review-pending-deployments-for-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *461 - - *462 - - *485 + - *465 + - *466 + - *489 requestBody: required: true content: @@ -70625,7 +72248,7 @@ paths: application/json: schema: type: array - items: &603 + items: &607 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -70737,7 +72360,7 @@ paths: - created_at - updated_at examples: - default: &604 + default: &608 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -70791,11 +72414,11 @@ paths: operationId: actions/re-run-workflow externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *461 - - *462 - - *485 + - *465 + - *466 + - *489 requestBody: required: false content: @@ -70838,11 +72461,11 @@ paths: operationId: actions/re-run-workflow-failed-jobs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *461 - - *462 - - *485 + - *465 + - *466 + - *489 requestBody: required: false content: @@ -70886,7 +72509,7 @@ paths: in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing - for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone + for GitHub Actions](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository." @@ -70895,11 +72518,11 @@ paths: operationId: actions/get-workflow-run-usage externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *461 - - *462 - - *485 + - *465 + - *466 + - *489 responses: '200': description: Response @@ -71034,10 +72657,10 @@ paths: operationId: actions/list-repo-secrets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-repository-secrets parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 responses: @@ -71055,9 +72678,9 @@ paths: type: integer secrets: type: array - items: *492 + items: *496 examples: - default: *493 + default: *497 headers: Link: *45 x-github: @@ -71080,18 +72703,18 @@ paths: operationId: actions/get-repo-public-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-public-key parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response content: application/json: - schema: *494 + schema: *498 examples: - default: *495 + default: *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71111,19 +72734,19 @@ paths: operationId: actions/get-repo-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-secret parameters: - - *461 - - *462 + - *465 + - *466 - *288 responses: '200': description: Response content: application/json: - schema: *492 + schema: *496 examples: - default: &629 + default: &633 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -71137,7 +72760,7 @@ paths: summary: Create or update a repository secret description: |- Creates or updates a repository secret with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." Authenticated users must have collaborator access to a repository to create, update, or read secrets. @@ -71147,10 +72770,10 @@ paths: operationId: actions/create-or-update-repo-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *461 - - *462 + - *465 + - *466 - *288 requestBody: required: true @@ -71163,7 +72786,7 @@ paths: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public - key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key) + key](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-public-key) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: @@ -71206,10 +72829,10 @@ paths: operationId: actions/delete-repo-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-a-repository-secret parameters: - - *461 - - *462 + - *465 + - *466 - *288 responses: '204': @@ -71233,11 +72856,11 @@ paths: operationId: actions/list-repo-variables externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-repository-variables parameters: - - *461 - - *462 - - *479 + - *465 + - *466 + - *483 - *19 responses: '200': @@ -71254,9 +72877,9 @@ paths: type: integer variables: type: array - items: *496 + items: *500 examples: - default: *497 + default: *501 headers: Link: *45 x-github: @@ -71277,10 +72900,10 @@ paths: operationId: actions/create-repo-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-a-repository-variable parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -71330,19 +72953,19 @@ paths: operationId: actions/get-repo-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-a-repository-variable parameters: - - *461 - - *462 + - *465 + - *466 - *291 responses: '200': description: Response content: application/json: - schema: *496 + schema: *500 examples: - default: &630 + default: &634 value: name: USERNAME value: octocat @@ -71366,10 +72989,10 @@ paths: operationId: actions/update-repo-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-a-repository-variable parameters: - - *461 - - *462 + - *465 + - *466 - *291 requestBody: required: true @@ -71410,10 +73033,10 @@ paths: operationId: actions/delete-repo-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-a-repository-variable parameters: - - *461 - - *462 + - *465 + - *466 - *291 responses: '204': @@ -71437,10 +73060,10 @@ paths: operationId: actions/list-repo-workflows externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#list-repository-workflows parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 responses: @@ -71458,7 +73081,7 @@ paths: type: integer workflows: type: array - items: &498 + items: &502 title: Workflow description: A GitHub Actions workflow type: object @@ -71574,11 +73197,11 @@ paths: operationId: actions/get-workflow externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#get-a-workflow parameters: - - *461 - - *462 - - &499 + - *465 + - *466 + - &503 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -71593,7 +73216,7 @@ paths: description: Response content: application/json: - schema: *498 + schema: *502 examples: default: value: @@ -71624,11 +73247,11 @@ paths: operationId: actions/disable-workflow externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#disable-a-workflow parameters: - - *461 - - *462 - - *499 + - *465 + - *466 + - *503 responses: '204': description: Response @@ -71651,11 +73274,11 @@ paths: - actions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *461 - - *462 - - *499 + - *465 + - *466 + - *503 responses: '204': description: Empty response when `return_run_details` parameter is `false`. @@ -71740,11 +73363,11 @@ paths: operationId: actions/enable-workflow externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#enable-a-workflow parameters: - - *461 - - *462 - - *499 + - *465 + - *466 + - *503 responses: '204': description: Response @@ -71757,7 +73380,7 @@ paths: get: 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-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). + 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-cloud@latest/rest/guides/getting-started-with-the-rest-api#parameters). Anyone with read access to the repository can use this endpoint @@ -71769,21 +73392,21 @@ paths: operationId: actions/list-workflow-runs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-workflow + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *461 - - *462 - - *499 - - *500 - - *501 - - *502 + - *465 + - *466 - *503 - - *17 - - *19 - *504 - - *483 - *505 - *506 + - *507 + - *17 + - *19 + - *508 + - *487 + - *509 + - *510 responses: '200': description: Response @@ -71799,9 +73422,9 @@ paths: type: integer workflow_runs: type: array - items: *484 + items: *488 examples: - default: *507 + default: *511 headers: Link: *45 x-github: @@ -71822,7 +73445,7 @@ paths: system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing - billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou + billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the @@ -71832,11 +73455,11 @@ paths: operationId: actions/get-workflow-usage externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#get-workflow-usage parameters: - - *461 - - *462 - - *499 + - *465 + - *466 + - *503 responses: '200': description: Response @@ -71889,16 +73512,16 @@ paths: Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. For more information about viewing repository activity, - see "[Viewing activity and data for your repository](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository)." + see "[Viewing activity and data for your repository](https://docs.github.com/enterprise-cloud@latest/repositories/viewing-activity-and-data-for-your-repository)." tags: - repos operationId: repos/list-activities externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-activities parameters: - - *461 - - *462 + - *465 + - *466 - *110 - *17 - *108 @@ -72057,17 +73680,17 @@ paths: "/repos/{owner}/{repo}/assignees": get: summary: List assignees - description: Lists the [available assignees](https://docs.github.com/enterprise-cloud@latest//articles/assigning-issues-and-pull-requests-to-other-github-users/) + description: Lists the [available assignees](https://docs.github.com/enterprise-cloud@latest/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. tags: - issues operationId: issues/list-assignees externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#list-assignees parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 responses: @@ -72102,10 +73725,10 @@ paths: operationId: issues/check-user-can-be-assigned externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *461 - - *462 + - *465 + - *466 - name: assignee in: path required: true @@ -72133,16 +73756,16 @@ paths: The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. - Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). tags: - repos operationId: repos/create-attestation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#create-an-attestation + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/attestations#create-an-attestation parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -72244,16 +73867,16 @@ paths: The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required. - **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). tags: - repos operationId: repos/list-attestations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#list-attestations + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/attestations#list-attestations parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *108 - *109 @@ -72310,7 +73933,7 @@ paths: initiator: type: string examples: - default: *508 + default: *512 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72328,10 +73951,10 @@ paths: operationId: repos/list-autolinks externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -72339,7 +73962,7 @@ paths: application/json: schema: type: array - items: &509 + items: &513 title: Autolink reference description: An autolink reference. type: object @@ -72396,10 +74019,10 @@ paths: operationId: repos/create-autolink externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#create-an-autolink-reference-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -72438,9 +74061,9 @@ paths: description: response content: application/json: - schema: *509 + schema: *513 examples: - default: &510 + default: &514 value: id: 1 key_prefix: TICKET- @@ -72469,11 +74092,11 @@ paths: operationId: repos/get-autolink externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-an-autolink-reference-of-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *461 - - *462 - - &511 + - *465 + - *466 + - &515 name: autolink_id description: The unique identifier of the autolink. in: path @@ -72485,9 +74108,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *513 examples: - default: *510 + default: *514 '404': *6 x-github: githubCloudOnly: false @@ -72505,11 +74128,11 @@ paths: operationId: repos/delete-autolink externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#delete-an-autolink-reference-from-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *461 - - *462 - - *511 + - *465 + - *466 + - *515 responses: '204': description: Response @@ -72525,16 +74148,16 @@ paths: description: Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring Dependabot security - updates](https://docs.github.com/enterprise-cloud@latest//articles/configuring-automated-security-fixes)". + updates](https://docs.github.com/enterprise-cloud@latest/articles/configuring-automated-security-fixes)". tags: - repos operationId: repos/check-automated-security-fixes externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response if Dependabot is enabled @@ -72576,16 +74199,16 @@ paths: summary: Enable Dependabot security updates description: Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring - Dependabot security updates](https://docs.github.com/enterprise-cloud@latest//articles/configuring-automated-security-fixes)". + Dependabot security updates](https://docs.github.com/enterprise-cloud@latest/articles/configuring-automated-security-fixes)". tags: - repos operationId: repos/enable-automated-security-fixes externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-dependabot-security-updates parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': description: Response @@ -72598,16 +74221,16 @@ paths: summary: Disable Dependabot security updates description: Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring - Dependabot security updates](https://docs.github.com/enterprise-cloud@latest//articles/configuring-automated-security-fixes)". + Dependabot security updates](https://docs.github.com/enterprise-cloud@latest/articles/configuring-automated-security-fixes)". tags: - repos operationId: repos/disable-automated-security-fixes externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-dependabot-security-updates parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': description: Response @@ -72625,10 +74248,10 @@ paths: operationId: repos/list-branches externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#list-branches parameters: - - *461 - - *462 + - *465 + - *466 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -72666,7 +74289,7 @@ paths: - url protected: type: boolean - protection: &513 + protection: &517 title: Branch Protection description: Branch Protection type: object @@ -72709,7 +74332,7 @@ paths: required: - contexts - checks - enforce_admins: &516 + enforce_admins: &520 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -72726,7 +74349,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &518 + required_pull_request_reviews: &522 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -72810,7 +74433,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &515 + restrictions: &519 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -73101,14 +74724,14 @@ paths: operationId: repos/get-branch externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#get-a-branch parameters: - - *461 - - *462 - - &514 + - *465 + - *466 + - &518 name: branch description: The name of the branch. Cannot contain wildcard characters. To - use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql). + use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql). in: path required: true schema: @@ -73119,14 +74742,14 @@ paths: description: Response content: application/json: - schema: &524 + schema: &528 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &575 + commit: &579 title: Commit description: Commit type: object @@ -73165,7 +74788,7 @@ paths: author: anyOf: - type: 'null' - - &512 + - &516 title: Git User description: Metaproperties for Git author/committer information. @@ -73187,7 +74810,7 @@ paths: committer: anyOf: - type: 'null' - - *512 + - *516 message: type: string examples: @@ -73211,7 +74834,7 @@ paths: required: - sha - url - verification: &636 + verification: &640 title: Verification type: object properties: @@ -73291,7 +74914,7 @@ paths: type: integer files: type: array - items: &586 + items: &590 title: Diff Entry description: Diff Entry type: object @@ -73387,7 +75010,7 @@ paths: - self protected: type: boolean - protection: *513 + protection: *517 protection_url: type: string format: uri @@ -73496,7 +75119,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *467 + '301': *471 '404': *6 x-github: githubCloudOnly: false @@ -73509,24 +75132,24 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/get-branch-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-branch-protection parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 responses: '200': description: Response content: application/json: - schema: *513 + schema: *517 examples: default: value: @@ -73704,7 +75327,7 @@ paths: put: summary: Update branch protection description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Protecting a branch requires admin or owner permissions to the repository. @@ -73718,11 +75341,11 @@ paths: operationId: repos/update-branch-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-branch-protection parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 requestBody: required: true content: @@ -73816,7 +75439,7 @@ paths: approving reviews when someone pushes a new commit. require_code_owner_reviews: type: boolean - description: Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-cloud@latest//articles/about-code-owners/) + description: Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-cloud@latest/articles/about-code-owners/) review them. required_approving_review_count: type: integer @@ -73885,7 +75508,7 @@ paths: commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear - commit history](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/requiring-a-linear-commit-history)" + commit history](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation.' allow_force_pushes: type: @@ -73895,14 +75518,14 @@ paths: with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to - a protected branch](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" + a protected branch](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation."' allow_deletions: type: boolean description: 'Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, - see "[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" + see "[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation.' block_creations: type: boolean @@ -73982,7 +75605,7 @@ paths: url: type: string format: uri - required_status_checks: &521 + required_status_checks: &525 title: Status Check Policy description: Status Check Policy type: object @@ -74141,7 +75764,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *515 + restrictions: *519 required_conversation_resolution: type: object properties: @@ -74244,18 +75867,18 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/delete-branch-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-branch-protection parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 responses: '204': description: Response @@ -74271,26 +75894,26 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/get-admin-branch-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 responses: '200': description: Response content: application/json: - schema: *516 + schema: *520 examples: - default: &517 + default: &521 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -74302,7 +75925,7 @@ paths: post: summary: Set admin branch protection description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. tags: @@ -74310,19 +75933,19 @@ paths: operationId: repos/set-admin-branch-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 responses: '200': description: Response content: application/json: - schema: *516 + schema: *520 examples: - default: *517 + default: *521 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74331,7 +75954,7 @@ paths: delete: summary: Delete admin branch protection description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. tags: @@ -74339,11 +75962,11 @@ paths: operationId: repos/delete-admin-branch-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 responses: '204': description: Response @@ -74359,26 +75982,26 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/get-pull-request-review-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 responses: '200': description: Response content: application/json: - schema: *518 + schema: *522 examples: - default: &519 + default: &523 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -74461,7 +76084,7 @@ paths: patch: summary: Update pull request review protection description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. @@ -74472,11 +76095,11 @@ paths: operationId: repos/update-pull-request-review-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 requestBody: required: false content: @@ -74513,7 +76136,7 @@ paths: approving reviews when someone pushes a new commit. require_code_owner_reviews: type: boolean - description: Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-cloud@latest//articles/about-code-owners/) + description: Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-cloud@latest/articles/about-code-owners/) have reviewed. required_approving_review_count: type: integer @@ -74574,9 +76197,9 @@ paths: description: Response content: application/json: - schema: *518 + schema: *522 examples: - default: *519 + default: *523 '422': *15 x-github: githubCloudOnly: false @@ -74588,18 +76211,18 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/delete-pull-request-review-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 responses: '204': description: Response @@ -74613,9 +76236,9 @@ paths: get: summary: Get commit signature protection description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-cloud@latest//articles/signing-commits-with-gpg) in GitHub Help. + When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-cloud@latest/articles/signing-commits-with-gpg) in GitHub Help. > [!NOTE] > You must enable branch protection to require signed commits. @@ -74624,19 +76247,19 @@ paths: operationId: repos/get-commit-signature-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 responses: '200': description: Response content: application/json: - schema: *516 + schema: *520 examples: - default: &520 + default: &524 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -74649,7 +76272,7 @@ paths: post: summary: Create commit signature protection description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. tags: @@ -74657,19 +76280,19 @@ paths: operationId: repos/create-commit-signature-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 responses: '200': description: Response content: application/json: - schema: *516 + schema: *520 examples: - default: *520 + default: *524 '404': *6 x-github: githubCloudOnly: false @@ -74679,7 +76302,7 @@ paths: delete: summary: Delete commit signature protection description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. tags: @@ -74687,11 +76310,11 @@ paths: operationId: repos/delete-commit-signature-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 responses: '204': description: Response @@ -74707,26 +76330,26 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/get-status-checks-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-status-checks-protection parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 responses: '200': description: Response content: application/json: - schema: *521 + schema: *525 examples: - default: &522 + default: &526 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -74742,7 +76365,7 @@ paths: patch: summary: Update status check protection description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. tags: @@ -74750,11 +76373,11 @@ paths: operationId: repos/update-status-check-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-status-check-protection parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 requestBody: required: false content: @@ -74806,9 +76429,9 @@ paths: description: Response content: application/json: - schema: *521 + schema: *525 examples: - default: *522 + default: *526 '404': *6 '422': *15 x-github: @@ -74821,18 +76444,18 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/remove-status-check-protection externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-status-check-protection parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 responses: '204': description: Response @@ -74847,18 +76470,18 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/get-all-status-check-contexts externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 responses: '200': description: Response @@ -74883,18 +76506,18 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/add-status-check-contexts externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-status-check-contexts parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 requestBody: required: false content: @@ -74952,18 +76575,18 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/set-status-check-contexts externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-status-check-contexts parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 requestBody: required: false content: @@ -75018,18 +76641,18 @@ paths: description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/remove-status-check-contexts externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 requestBody: content: application/json: @@ -75082,7 +76705,7 @@ paths: get: summary: Get access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists who has access to this protected branch. @@ -75093,17 +76716,17 @@ paths: operationId: repos/get-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-access-restrictions parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 responses: '200': description: Response content: application/json: - schema: *515 + schema: *519 examples: default: value: @@ -75184,7 +76807,7 @@ paths: delete: summary: Delete access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Disables the ability to restrict who can push to this branch. tags: @@ -75192,11 +76815,11 @@ paths: operationId: repos/delete-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-access-restrictions parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 responses: '204': description: Response @@ -75209,7 +76832,7 @@ paths: get: summary: Get apps with access to the protected branch description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. tags: @@ -75217,11 +76840,11 @@ paths: operationId: repos/get-apps-with-access-to-protected-branch externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 responses: '200': description: Response @@ -75231,7 +76854,7 @@ paths: type: array items: *5 examples: - default: &523 + default: &527 value: - id: 1 slug: octoapp @@ -75278,7 +76901,7 @@ paths: post: summary: Add app access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. tags: @@ -75286,11 +76909,11 @@ paths: operationId: repos/add-app-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 requestBody: required: true content: @@ -75324,7 +76947,7 @@ paths: type: array items: *5 examples: - default: *523 + default: *527 '422': *15 x-github: githubCloudOnly: false @@ -75335,7 +76958,7 @@ paths: put: summary: Set app access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. tags: @@ -75343,11 +76966,11 @@ paths: operationId: repos/set-app-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 requestBody: required: true content: @@ -75381,7 +77004,7 @@ paths: type: array items: *5 examples: - default: *523 + default: *527 '422': *15 x-github: githubCloudOnly: false @@ -75392,7 +77015,7 @@ paths: delete: summary: Remove app access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. tags: @@ -75400,11 +77023,11 @@ paths: operationId: repos/remove-app-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 requestBody: required: true content: @@ -75438,7 +77061,7 @@ paths: type: array items: *5 examples: - default: *523 + default: *527 '422': *15 x-github: githubCloudOnly: false @@ -75450,7 +77073,7 @@ paths: get: summary: Get teams with access to the protected branch description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists the teams who have push access to this branch. The list includes child teams. tags: @@ -75458,11 +77081,11 @@ paths: operationId: repos/get-teams-with-access-to-protected-branch externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 responses: '200': description: Response @@ -75472,7 +77095,7 @@ paths: type: array items: *307 examples: - default: *390 + default: *394 '404': *6 x-github: githubCloudOnly: false @@ -75482,7 +77105,7 @@ paths: post: summary: Add team access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Grants the specified teams push access for this branch. You can also give push access to child teams. tags: @@ -75490,11 +77113,11 @@ paths: operationId: repos/add-team-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 requestBody: required: false content: @@ -75532,7 +77155,7 @@ paths: type: array items: *307 examples: - default: *390 + default: *394 '422': *15 x-github: githubCloudOnly: false @@ -75543,7 +77166,7 @@ paths: put: summary: Set team access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. tags: @@ -75551,11 +77174,11 @@ paths: operationId: repos/set-team-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 requestBody: required: false content: @@ -75593,7 +77216,7 @@ paths: type: array items: *307 examples: - default: *390 + default: *394 '422': *15 x-github: githubCloudOnly: false @@ -75604,7 +77227,7 @@ paths: delete: summary: Remove team access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removes the ability of a team to push to this branch. You can also remove push access for child teams. tags: @@ -75612,11 +77235,11 @@ paths: operationId: repos/remove-team-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 requestBody: content: application/json: @@ -75653,7 +77276,7 @@ paths: type: array items: *307 examples: - default: *390 + default: *394 '422': *15 x-github: githubCloudOnly: false @@ -75665,7 +77288,7 @@ paths: get: summary: Get users with access to the protected branch description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists the people who have push access to this branch. tags: @@ -75673,11 +77296,11 @@ paths: operationId: repos/get-users-with-access-to-protected-branch externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-users-with-access-to-the-protected-branch + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 responses: '200': description: Response @@ -75697,7 +77320,7 @@ paths: post: summary: Add user access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Grants the specified people push access for this branch. @@ -75709,11 +77332,11 @@ paths: operationId: repos/add-user-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 requestBody: required: true content: @@ -75757,7 +77380,7 @@ paths: put: summary: Set user access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. @@ -75769,11 +77392,11 @@ paths: operationId: repos/set-user-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 requestBody: required: true content: @@ -75817,7 +77440,7 @@ paths: delete: summary: Remove user access restrictions description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removes the ability of a user to push to this branch. @@ -75829,11 +77452,11 @@ paths: operationId: repos/remove-user-access-restrictions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 requestBody: required: true content: @@ -75881,7 +77504,7 @@ paths: Renames a branch in a repository. > [!NOTE] - > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/renaming-a-branch)". + > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/renaming-a-branch)". The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. @@ -75891,11 +77514,11 @@ paths: operationId: repos/rename-branch externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#rename-a-branch parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 requestBody: required: true content: @@ -75917,7 +77540,7 @@ paths: description: Response content: application/json: - schema: *524 + schema: *528 examples: default: value: @@ -76024,15 +77647,15 @@ paths: operationId: repos/list-repo-push-bypass-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/bypass-requests#list-repository-push-rule-bypass-requests + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/bypass-requests#list-repository-push-rule-bypass-requests x-github: githubCloudOnly: true enabledForGitHubApps: true category: repos subcategory: bypass-requests parameters: - - *461 - - *462 + - *465 + - *466 - *103 - *104 - *105 @@ -76061,15 +77684,15 @@ paths: operationId: repos/get-repo-push-bypass-request externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/bypass-requests#get-a-repository-push-bypass-request + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/bypass-requests#get-a-repository-push-bypass-request x-github: githubCloudOnly: true enabledForGitHubApps: true category: repos subcategory: bypass-requests parameters: - - *461 - - *462 + - *465 + - *466 - name: bypass_request_number in: path required: true @@ -76135,15 +77758,15 @@ paths: operationId: secret-scanning/list-repo-bypass-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: delegated-bypass parameters: - - *461 - - *462 + - *465 + - *466 - *103 - *104 - *105 @@ -76176,15 +77799,15 @@ paths: operationId: secret-scanning/get-bypass-request externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#get-a-bypass-request-for-secret-scanning + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#get-a-bypass-request-for-secret-scanning x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: delegated-bypass parameters: - - *461 - - *462 + - *465 + - *466 - name: bypass_request_number in: path required: true @@ -76247,15 +77870,15 @@ paths: operationId: secret-scanning/review-bypass-request externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#review-a-bypass-request-for-secret-scanning + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#review-a-bypass-request-for-secret-scanning x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: delegated-bypass parameters: - - *461 - - *462 + - *465 + - *466 - name: bypass_request_number in: path required: true @@ -76319,15 +77942,15 @@ paths: operationId: secret-scanning/dismiss-bypass-response externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#dismiss-a-response-on-a-bypass-request-for-secret-scanning + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/delegated-bypass#dismiss-a-response-on-a-bypass-request-for-secret-scanning x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: delegated-bypass parameters: - - *461 - - *462 + - *465 + - *466 - name: bypass_response_id in: path required: true @@ -76358,10 +77981,10 @@ paths: operationId: checks/create externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#create-a-check-run parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -76449,13 +78072,13 @@ paths: and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have - to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run) + to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see "[About - status checks](https://docs.github.com/enterprise-cloud@latest//articles/about-status-checks#checks)". + status checks](https://docs.github.com/enterprise-cloud@latest/articles/about-status-checks#checks)". maxItems: 50 items: type: object @@ -76537,11 +78160,11 @@ paths: app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the - [`check_run.requested_action` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) + [`check_run.requested_action` webhook](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs - and requested actions](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." + and requested actions](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -76640,7 +78263,7 @@ paths: description: Response content: application/json: - schema: &525 + schema: &529 title: CheckRun description: A check performed on the code of a given code change type: object @@ -76776,7 +78399,7 @@ paths: check. type: array items: *222 - deployment: &854 + deployment: &859 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -77061,11 +78684,11 @@ paths: operationId: checks/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#get-a-check-run parameters: - - *461 - - *462 - - &526 + - *465 + - *466 + - &530 name: check_run_id description: The unique identifier of the check run. in: path @@ -77077,9 +78700,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *529 examples: - default: &527 + default: &531 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -77177,11 +78800,11 @@ paths: operationId: checks/update externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run parameters: - - *461 - - *462 - - *526 + - *465 + - *466 + - *530 requestBody: required: true content: @@ -77261,12 +78884,12 @@ paths: UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you - have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run) + have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details - about annotations in the UI, see "[About status checks](https://docs.github.com/enterprise-cloud@latest//articles/about-status-checks#checks)". + about annotations in the UI, see "[About status checks](https://docs.github.com/enterprise-cloud@latest/articles/about-status-checks#checks)". maxItems: 50 items: type: object @@ -77346,7 +78969,7 @@ paths: which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check - runs and requested actions](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." + runs and requested actions](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -77421,9 +79044,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *529 examples: - default: *527 + default: *531 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77441,11 +79064,11 @@ paths: operationId: checks/list-annotations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-run-annotations parameters: - - *461 - - *462 - - *526 + - *465 + - *466 + - *530 - *17 - *19 responses: @@ -77545,19 +79168,19 @@ paths: post: summary: Rerequest a check run description: |- - Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run) to update the check_run if desired. + Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run) to update the check_run if desired. - For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". tags: - checks operationId: checks/rerequest-run externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#rerequest-a-check-run parameters: - - *461 - - *462 - - *526 + - *465 + - *466 + - *530 responses: '201': description: Response @@ -77588,7 +79211,7 @@ paths: post: summary: Create a check suite description: |- - Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites)". + Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#update-repository-preferences-for-check-suites)". > [!NOTE] > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. @@ -77599,10 +79222,10 @@ paths: operationId: checks/create-suite externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#create-a-check-suite parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -77624,7 +79247,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &529 + schema: &533 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -77722,7 +79345,7 @@ paths: - string - 'null' format: date-time - head_commit: *528 + head_commit: *532 latest_check_runs_count: type: integer check_runs_url: @@ -77750,7 +79373,7 @@ paths: - check_runs_url - pull_requests examples: - default: &530 + default: &534 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -78041,9 +79664,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *529 + schema: *533 examples: - default: *530 + default: *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78053,17 +79676,17 @@ paths: patch: summary: Update repository preferences for check suites description: |- - Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite). + Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. tags: - checks operationId: checks/set-suites-preferences externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -78370,11 +79993,11 @@ paths: operationId: checks/get-suite externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite parameters: - - *461 - - *462 - - &531 + - *465 + - *466 + - &535 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -78386,9 +80009,9 @@ paths: description: Response content: application/json: - schema: *529 + schema: *533 examples: - default: *530 + default: *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78409,19 +80032,19 @@ paths: operationId: checks/list-for-suite externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-in-a-check-suite + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *461 - - *462 - - *531 - - &581 + - *465 + - *466 + - *535 + - &585 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &582 + - &586 name: status description: Returns check runs with the specified `status`. in: query @@ -78460,9 +80083,9 @@ paths: type: integer check_runs: type: array - items: *525 + items: *529 examples: - default: &583 + default: &587 value: total_count: 1 check_runs: @@ -78554,7 +80177,7 @@ paths: post: summary: Rerequest a check suite description: Triggers GitHub to rerequest an existing check suite, without pushing - new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_suite) + new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. tags: @@ -78562,11 +80185,11 @@ paths: operationId: checks/rerequest-suite externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#rerequest-a-check-suite parameters: - - *461 - - *462 - - *531 + - *465 + - *466 + - *535 responses: '201': description: Response @@ -78597,23 +80220,23 @@ paths: operationId: code-scanning/list-alerts-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 - *311 - *312 - *19 - *17 - - &547 + - &551 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *532 - - &548 + schema: *536 + - &552 name: pr description: The number of the pull request for the results you want to list. in: query @@ -78644,7 +80267,7 @@ paths: be returned. in: query required: false - schema: *533 + schema: *537 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -78668,7 +80291,7 @@ paths: updated_at: *135 url: *132 html_url: *133 - instances_url: *534 + instances_url: *538 state: *113 fixed_at: *137 dismissed_by: @@ -78676,11 +80299,11 @@ paths: - type: 'null' - *4 dismissed_at: *136 - dismissed_reason: *535 - dismissed_comment: *536 - rule: *537 - tool: *538 - most_recent_instance: *539 + dismissed_reason: *539 + dismissed_comment: *540 + rule: *541 + tool: *542 + most_recent_instance: *543 dismissal_approved_by: anyOf: - type: 'null' @@ -78803,7 +80426,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &540 + '403': &544 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -78828,11 +80451,11 @@ paths: operationId: code-scanning/get-alert externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *461 - - *462 - - &541 + - *465 + - *466 + - &545 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -78846,7 +80469,7 @@ paths: description: Response content: application/json: - schema: &542 + schema: &546 type: object properties: number: *127 @@ -78854,7 +80477,7 @@ paths: updated_at: *135 url: *132 html_url: *133 - instances_url: *534 + instances_url: *538 state: *113 fixed_at: *137 dismissed_by: @@ -78862,8 +80485,8 @@ paths: - type: 'null' - *4 dismissed_at: *136 - dismissed_reason: *535 - dismissed_comment: *536 + dismissed_reason: *539 + dismissed_comment: *540 rule: type: object properties: @@ -78925,8 +80548,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *538 - most_recent_instance: *539 + tool: *542 + most_recent_instance: *543 dismissal_approved_by: anyOf: - type: 'null' @@ -79022,7 +80645,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *540 + '403': *544 '404': *6 '503': *192 x-github: @@ -79040,11 +80663,11 @@ paths: - code-scanning externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *461 - - *462 - - *541 + - *465 + - *466 + - *545 requestBody: required: true content: @@ -79059,8 +80682,8 @@ paths: enum: - open - dismissed - dismissed_reason: *535 - dismissed_comment: *536 + dismissed_reason: *539 + dismissed_comment: *540 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -79088,7 +80711,7 @@ paths: description: Response content: application/json: - schema: *542 + schema: *546 examples: default: value: @@ -79164,7 +80787,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &546 + '403': &550 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -79189,17 +80812,17 @@ paths: operationId: code-scanning/get-autofix externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *461 - - *462 - - *541 + - *465 + - *466 + - *545 responses: '200': description: Response content: application/json: - schema: &543 + schema: &547 type: object properties: status: @@ -79226,13 +80849,13 @@ paths: - description - started_at examples: - default: &544 + default: &548 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &545 + '400': &549 description: Bad Request content: application/json: @@ -79243,7 +80866,7 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *540 + '403': *544 '404': *6 '503': *192 x-github: @@ -79266,31 +80889,31 @@ paths: operationId: code-scanning/create-autofix externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *461 - - *462 - - *541 + - *465 + - *466 + - *545 responses: '200': description: OK content: application/json: - schema: *543 + schema: *547 examples: - default: *544 + default: *548 '202': description: Accepted content: application/json: - schema: *543 + schema: *547 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *545 + '400': *549 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -79320,11 +80943,11 @@ paths: operationId: code-scanning/commit-autofix externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *461 - - *462 - - *541 + - *465 + - *466 + - *545 requestBody: required: false content: @@ -79370,8 +80993,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *545 - '403': *546 + '400': *549 + '403': *550 '404': *6 '422': description: Unprocessable Entity @@ -79393,15 +81016,15 @@ paths: operationId: code-scanning/list-alert-instances externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *461 - - *462 - - *541 + - *465 + - *466 + - *545 - *19 - *17 - - *547 - - *548 + - *551 + - *552 responses: '200': description: Response @@ -79412,10 +81035,10 @@ paths: items: type: object properties: - ref: *532 - analysis_key: *549 - environment: *550 - category: *551 + ref: *536 + analysis_key: *553 + environment: *554 + category: *555 state: type: - string @@ -79432,7 +81055,7 @@ paths: properties: text: type: string - location: *552 + location: *556 html_url: type: string classifications: @@ -79440,7 +81063,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: *553 + items: *557 examples: default: value: @@ -79477,7 +81100,7 @@ paths: end_column: 50 classifications: - source - '403': *540 + '403': *544 '404': *6 '503': *192 x-github: @@ -79509,27 +81132,27 @@ paths: - code-scanning externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 - *311 - *312 - *19 - *17 - - *548 + - *552 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *532 + schema: *536 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &554 + schema: &558 type: string description: An identifier for the upload. examples: @@ -79551,23 +81174,23 @@ paths: application/json: schema: type: array - items: &555 + items: &559 type: object properties: - ref: *532 - commit_sha: &563 + ref: *536 + commit_sha: &567 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *549 + analysis_key: *553 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *551 + category: *555 error: type: string examples: @@ -79592,8 +81215,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *554 - tool: *538 + sarif_id: *558 + tool: *542 deletable: type: boolean warning: @@ -79655,7 +81278,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *540 + '403': *544 '404': *6 '503': *192 x-github: @@ -79679,7 +81302,7 @@ paths: For very old analyses this data is not available, and `0` is returned in this field. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. @@ -79689,10 +81312,10 @@ paths: - code-scanning externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -79705,7 +81328,7 @@ paths: description: Response content: application/json: - schema: *555 + schema: *559 examples: response: summary: application/json response @@ -79759,7 +81382,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *540 + '403': *544 '404': *6 '422': description: Response if analysis could not be processed @@ -79844,10 +81467,10 @@ paths: - code-scanning externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *461 - - *462 + - *465 + - *466 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -79903,7 +81526,7 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *546 + '403': *550 '404': *6 '503': *192 x-github: @@ -79923,10 +81546,10 @@ paths: operationId: code-scanning/list-codeql-databases externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -79934,7 +81557,7 @@ paths: application/json: schema: type: array - items: &556 + items: &560 title: CodeQL Database description: A CodeQL database. type: object @@ -80046,7 +81669,7 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *540 + '403': *544 '404': *6 '503': *192 x-github: @@ -80063,7 +81686,7 @@ paths: By default this endpoint returns JSON metadata about the CodeQL database. To download the CodeQL database binary content, set the `Accept` header of the request - to [`application/zip`](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure + to [`application/zip`](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure your HTTP client is configured to follow redirects or use the `Location` header to make a second request to get the redirect URL. @@ -80073,10 +81696,10 @@ paths: operationId: code-scanning/get-codeql-database externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 - name: language in: path description: The language of the CodeQL database. @@ -80088,7 +81711,7 @@ paths: description: Response content: application/json: - schema: *556 + schema: *560 examples: default: value: @@ -80120,9 +81743,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &590 + '302': &594 description: Found - '403': *540 + '403': *544 '404': *6 '503': *192 x-github: @@ -80142,10 +81765,10 @@ paths: operationId: code-scanning/delete-codeql-database externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *461 - - *462 + - *465 + - *466 - name: language in: path description: The language of the CodeQL database. @@ -80155,7 +81778,7 @@ paths: responses: '204': description: Response - '403': *546 + '403': *550 '404': *6 '503': *192 x-github: @@ -80170,7 +81793,7 @@ paths: description: |- Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories. - Get started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/enterprise-cloud@latest//code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis). + Get started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/enterprise-cloud@latest/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis). Use the `owner` and `repo` parameters in the URL to specify the controller repository that will be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis. @@ -80181,10 +81804,10 @@ paths: operationId: code-scanning/create-variant-analysis externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-a-codeql-variant-analysis + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -80193,7 +81816,7 @@ paths: type: object additionalProperties: false properties: - language: &557 + language: &561 type: string description: The language targeted by the CodeQL query enum: @@ -80273,7 +81896,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &561 + schema: &565 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -80283,7 +81906,7 @@ paths: description: The ID of the variant analysis. controller_repo: *120 actor: *4 - query_language: *557 + query_language: *561 query_pack_url: type: string description: The download url for the query pack. @@ -80331,7 +81954,7 @@ paths: items: type: object properties: - repository: &558 + repository: &562 title: Repository Identifier description: Repository Identifier type: object @@ -80373,7 +81996,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &562 + analysis_status: &566 type: string description: The new status of the CodeQL variant analysis repository task. @@ -80405,7 +82028,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &559 + access_mismatch_repos: &563 type: object properties: repository_count: @@ -80420,7 +82043,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *558 + items: *562 required: - repository_count - repositories @@ -80443,8 +82066,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *559 - over_limit_repos: *559 + no_codeql_db_repos: *563 + over_limit_repos: *563 required: - access_mismatch_repos - not_found_repos @@ -80460,7 +82083,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &560 + value: &564 summary: Default response value: id: 1 @@ -80606,10 +82229,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *560 + value: *564 repository_lists: summary: Response for a successful variant analysis submission - value: *560 + value: *564 '404': *6 '422': description: Unable to process variant analysis submission @@ -80635,10 +82258,10 @@ paths: operationId: code-scanning/get-variant-analysis externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *461 - - *462 + - *465 + - *466 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -80650,9 +82273,9 @@ paths: description: Response content: application/json: - schema: *561 + schema: *565 examples: - default: *560 + default: *564 '404': *6 '503': *192 x-github: @@ -80673,9 +82296,9 @@ paths: operationId: code-scanning/get-variant-analysis-repo-task externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *461 + - *465 - name: repo in: path description: The name of the controller repository. @@ -80710,7 +82333,7 @@ paths: type: object properties: repository: *120 - analysis_status: *562 + analysis_status: *566 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -80833,10 +82456,10 @@ paths: operationId: code-scanning/get-default-setup externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -80929,7 +82552,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *540 + '403': *544 '404': *6 '503': *192 x-github: @@ -80948,10 +82571,10 @@ paths: operationId: code-scanning/update-default-setup externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -81045,7 +82668,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *546 + '403': *550 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -81070,7 +82693,7 @@ paths: summary: Upload an analysis as SARIF data description: "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, - see \"[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/troubleshooting-sarif).\"\n\nThere + see \"[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, @@ -81088,7 +82711,7 @@ paths: analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results - exceed one or more limits](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| + exceed one or more limits](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** \ |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| @@ -81114,10 +82737,10 @@ paths: - code-scanning externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -81125,7 +82748,7 @@ paths: schema: type: object properties: - commit_sha: *563 + commit_sha: *567 ref: type: string description: |- @@ -81138,7 +82761,7 @@ paths: description: A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding - string. For more information, see "[SARIF support for code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secure-coding/sarif-support-for-code-scanning)." + string. For more information, see "[SARIF support for code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secure-coding/sarif-support-for-code-scanning)." type: string checkout_uri: description: |- @@ -81185,7 +82808,7 @@ paths: schema: type: object properties: - id: *554 + id: *558 url: type: string description: The REST API URL for checking the status of the upload. @@ -81199,7 +82822,7 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *546 + '403': *550 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -81220,10 +82843,10 @@ paths: - code-scanning externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-information-about-a-sarif-upload + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *461 - - *462 + - *465 + - *466 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -81271,7 +82894,7 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *540 + '403': *544 '404': description: Not Found if the sarif id does not match any upload '503': *192 @@ -81294,10 +82917,10 @@ paths: operationId: code-security/get-configuration-for-repository externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -81370,16 +82993,16 @@ paths: file. For more information about the correct CODEOWNERS syntax, - see "[About code owners](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." + see "[About code owners](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." tags: - repos operationId: repos/codeowners-errors externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-codeowners-errors parameters: - - *461 - - *462 + - *465 + - *466 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -81503,12 +83126,12 @@ paths: operationId: codespaces/list-in-repository-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user parameters: - *17 - *19 - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -81524,7 +83147,7 @@ paths: type: integer codespaces: type: array - items: *381 + items: *385 examples: default: value: @@ -81820,10 +83443,10 @@ paths: operationId: codespaces/create-with-repo-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -81887,17 +83510,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *381 + schema: *385 examples: - default: *564 + default: *568 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *381 + schema: *385 examples: - default: *564 + default: *568 '400': *14 '401': *23 '403': *27 @@ -81922,12 +83545,12 @@ paths: operationId: codespaces/list-devcontainers-in-repository-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#list-devcontainer-configurations-in-a-repository-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#list-devcontainer-configurations-in-a-repository-for-the-authenticated-user parameters: - *17 - *19 - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -81989,10 +83612,10 @@ paths: operationId: codespaces/repo-machines-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-available-machine-types-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -82029,9 +83652,9 @@ paths: type: integer machines: type: array - items: *565 + items: *569 examples: - default: &800 + default: &804 value: total_count: 2 machines: @@ -82069,10 +83692,10 @@ paths: operationId: codespaces/pre-flight-with-repo-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *461 - - *462 + - *465 + - *466 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -82157,10 +83780,10 @@ paths: operationId: codespaces/check-permissions-for-devcontainer externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *461 - - *462 + - *465 + - *466 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -82227,10 +83850,10 @@ paths: operationId: codespaces/list-repo-secrets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 responses: @@ -82248,7 +83871,7 @@ paths: type: integer secrets: type: array - items: &569 + items: &573 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -82269,7 +83892,7 @@ paths: - created_at - updated_at examples: - default: *566 + default: *570 headers: Link: *45 x-github: @@ -82290,18 +83913,18 @@ paths: operationId: codespaces/get-repo-public-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response content: application/json: - schema: *567 + schema: *571 examples: - default: *568 + default: *572 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -82319,19 +83942,19 @@ paths: operationId: codespaces/get-repo-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *461 - - *462 + - *465 + - *466 - *288 responses: '200': description: Response content: application/json: - schema: *569 + schema: *573 examples: - default: *570 + default: *574 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82341,7 +83964,7 @@ paths: summary: Create or update a repository secret description: |- Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. tags: @@ -82349,10 +83972,10 @@ paths: operationId: codespaces/create-or-update-repo-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#create-or-update-a-repository-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *461 - - *462 + - *465 + - *466 - *288 requestBody: required: true @@ -82365,7 +83988,7 @@ paths: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public - key](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key) + key](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: @@ -82403,10 +84026,10 @@ paths: operationId: codespaces/delete-repo-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *461 - - *462 + - *465 + - *466 - *288 responses: '204': @@ -82433,10 +84056,10 @@ paths: operationId: repos/list-collaborators externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *461 - - *462 + - *465 + - *466 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -82474,7 +84097,7 @@ paths: application/json: schema: type: array - items: &571 + items: &575 title: Collaborator description: Collaborator type: object @@ -82665,10 +84288,10 @@ paths: operationId: repos/check-collaborator externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *461 - - *462 + - *465 + - *466 - *140 responses: '204': @@ -82683,21 +84306,21 @@ paths: put: summary: Add a repository collaborator description: |- - Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an "outside collaborator" (if they are not an Enterprise Managed User) or a "repository collaborator" if they are an Enterprise Managed User. These users are exempt from some organization policies - see "[Adding outside collaborators to repositories](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)" to learn more about these collaborator types. + Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an "outside collaborator" (if they are not an Enterprise Managed User) or a "repository collaborator" if they are an Enterprise Managed User. These users are exempt from some organization policies - see "[Adding outside collaborators to repositories](https://docs.github.com/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)" to learn more about these collaborator types. - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). - Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)" and "[Setting permissions for adding outside collaborators](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" for organization settings. + Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)" and "[Setting permissions for adding outside collaborators](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" for organization settings. - For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: + For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: ``` Cannot assign {member} permission of {role name} ``` - Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method)." - The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations). + The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations). For Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise. @@ -82713,10 +84336,10 @@ paths: operationId: repos/add-collaborator externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *461 - - *462 + - *465 + - *466 - *140 requestBody: required: false @@ -82743,7 +84366,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &648 + schema: &652 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -82963,16 +84586,16 @@ paths: Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. - For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". + For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". tags: - repos operationId: repos/remove-collaborator externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *461 - - *462 + - *465 + - *466 - *140 responses: '204': @@ -83002,10 +84625,10 @@ paths: operationId: repos/get-collaborator-permission-level externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *461 - - *462 + - *465 + - *466 - *140 responses: '200': @@ -83026,7 +84649,7 @@ paths: user: anyOf: - type: 'null' - - *571 + - *575 required: - permission - role_name @@ -83067,7 +84690,7 @@ paths: description: |- Lists the commit comments for a specified repository. Comments are ordered by ascending ID. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -83078,10 +84701,10 @@ paths: operationId: repos/list-commit-comments-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 responses: @@ -83091,7 +84714,7 @@ paths: application/json: schema: type: array - items: &572 + items: &576 title: Commit Comment description: Commit Comment type: object @@ -83149,7 +84772,7 @@ paths: - created_at - updated_at examples: - default: &577 + default: &581 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -83195,7 +84818,7 @@ paths: description: |- Gets a specified commit comment. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -83206,19 +84829,19 @@ paths: operationId: repos/get-commit-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment parameters: - - *461 - - *462 + - *465 + - *466 - *233 responses: '200': description: Response content: application/json: - schema: *572 + schema: *576 examples: - default: &578 + default: &582 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -83262,7 +84885,7 @@ paths: description: |- Updates the contents of a specified commit comment. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -83273,10 +84896,10 @@ paths: operationId: repos/update-commit-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#update-a-commit-comment parameters: - - *461 - - *462 + - *465 + - *466 - *233 requestBody: required: true @@ -83299,7 +84922,7 @@ paths: description: Response content: application/json: - schema: *572 + schema: *576 examples: default: value: @@ -83348,10 +84971,10 @@ paths: operationId: repos/delete-commit-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#delete-a-commit-comment parameters: - - *461 - - *462 + - *465 + - *466 - *233 responses: '204': @@ -83365,19 +84988,19 @@ paths: "/repos/{owner}/{repo}/comments/{comment_id}/reactions": get: summary: List reactions for a commit comment - description: List the reactions to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment). + description: List the reactions to a [commit comment](https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment). tags: - reactions operationId: reactions/list-for-commit-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *461 - - *462 + - *465 + - *466 - *233 - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). + description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. in: query required: false @@ -83401,7 +85024,7 @@ paths: application/json: schema: type: array - items: &573 + items: &577 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -83445,7 +85068,7 @@ paths: - content - created_at examples: - default: &651 + default: &655 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -83480,7 +85103,7 @@ paths: subcategory: reactions post: summary: Create reaction for a commit comment - description: Create a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment). + description: Create a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. tags: @@ -83488,10 +85111,10 @@ paths: operationId: reactions/create-for-commit-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *461 - - *462 + - *465 + - *466 - *233 requestBody: required: true @@ -83502,7 +85125,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) + description: The [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions) to add to the commit comment. enum: - "+1" @@ -83524,9 +85147,9 @@ paths: description: Reaction exists content: application/json: - schema: *573 + schema: *577 examples: - default: &574 + default: &578 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -83555,9 +85178,9 @@ paths: description: Reaction created content: application/json: - schema: *573 + schema: *577 examples: - default: *574 + default: *578 '422': *15 x-github: githubCloudOnly: false @@ -83571,18 +85194,18 @@ paths: > [!NOTE] > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. - Delete a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment). + Delete a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment). tags: - reactions operationId: reactions/delete-for-commit-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *461 - - *462 + - *465 + - *466 - *233 - - &652 + - &656 name: reaction_id description: The unique identifier of the reaction. in: path @@ -83635,10 +85258,10 @@ paths: operationId: repos/list-commits externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-commits parameters: - - *461 - - *462 + - *465 + - *466 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -83694,9 +85317,9 @@ paths: application/json: schema: type: array - items: *575 + items: *579 examples: - default: &701 + default: &705 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -83780,7 +85403,7 @@ paths: get: summary: List branches for HEAD commit description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. tags: @@ -83788,11 +85411,11 @@ paths: operationId: repos/list-branches-for-head-commit externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-branches-for-head-commit parameters: - - *461 - - *462 - - &576 + - *465 + - *466 + - &580 name: commit_sha description: The SHA of the commit. in: path @@ -83851,7 +85474,7 @@ paths: description: |- Lists the comments for a specified commit. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -83862,11 +85485,11 @@ paths: operationId: repos/list-comments-for-commit externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#list-commit-comments parameters: - - *461 - - *462 - - *576 + - *465 + - *466 + - *580 - *17 - *19 responses: @@ -83876,9 +85499,9 @@ paths: application/json: schema: type: array - items: *572 + items: *576 examples: - default: *577 + default: *581 headers: Link: *45 x-github: @@ -83891,9 +85514,9 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -83904,11 +85527,11 @@ paths: operationId: repos/create-commit-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#create-a-commit-comment parameters: - - *461 - - *462 - - *576 + - *465 + - *466 + - *580 requestBody: required: true content: @@ -83943,9 +85566,9 @@ paths: description: Response content: application/json: - schema: *572 + schema: *576 examples: - default: *578 + default: *582 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -83971,11 +85594,11 @@ paths: operationId: repos/list-pull-requests-associated-with-commit externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-pull-requests-associated-with-a-commit + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *461 - - *462 - - *576 + - *465 + - *466 + - *580 - *17 - *19 responses: @@ -83985,9 +85608,9 @@ paths: application/json: schema: type: array - items: *579 + items: *583 examples: - default: &693 + default: &697 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -84482,7 +86105,7 @@ paths: > [!NOTE] > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. @@ -84522,13 +86145,13 @@ paths: operationId: repos/get-commit externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#get-a-commit parameters: - - *461 - - *462 + - *465 + - *466 - *19 - *17 - - &580 + - &584 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -84543,9 +86166,9 @@ paths: description: Response content: application/json: - schema: *575 + schema: *579 examples: - default: &679 + default: &683 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -84633,7 +86256,7 @@ paths: schema: type: string examples: - default: &587 + default: &591 value: | diff --git a/testfile b/testfile index 9bdeaeb..912c7ef 100644 @@ -84646,7 +86269,7 @@ paths: schema: type: string examples: - default: &588 + default: &592 value: | From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001 From: Mona Lisa <87831417+monalisa@users.noreply.github.com> @@ -84689,7 +86312,7 @@ paths: > [!NOTE] > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. + If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-cloud@latest/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-cloud@latest/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: @@ -84697,13 +86320,13 @@ paths: operationId: checks/list-for-ref externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-for-a-git-reference + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *461 - - *462 - - *580 - - *581 - - *582 + - *465 + - *466 + - *584 + - *585 + - *586 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -84737,9 +86360,9 @@ paths: type: integer check_runs: type: array - items: *525 + items: *529 examples: - default: *583 + default: *587 headers: Link: *45 x-github: @@ -84762,11 +86385,11 @@ paths: operationId: checks/list-suites-for-ref externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#list-check-suites-for-a-git-reference + url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *461 - - *462 - - *580 + - *465 + - *466 + - *584 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -84774,7 +86397,7 @@ paths: schema: type: integer example: 1 - - *581 + - *585 - *17 - *19 responses: @@ -84792,7 +86415,7 @@ paths: type: integer check_suites: type: array - items: *529 + items: *533 examples: default: value: @@ -84990,11 +86613,11 @@ paths: operationId: repos/get-combined-status-for-ref externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#get-the-combined-status-for-a-specific-reference + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *461 - - *462 - - *580 + - *465 + - *466 + - *584 - *17 - *19 responses: @@ -85194,11 +86817,11 @@ paths: operationId: repos/list-commit-statuses-for-ref externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *461 - - *462 - - *580 + - *465 + - *466 + - *584 - *17 - *19 responses: @@ -85208,7 +86831,7 @@ paths: application/json: schema: type: array - items: &754 + items: &758 title: Status description: The status of a commit. type: object @@ -85289,7 +86912,7 @@ paths: site_admin: false headers: Link: *45 - '301': *467 + '301': *471 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85307,7 +86930,7 @@ paths: The `health_percentage` score is defined as a percentage of how many of the recommended community health files are present. For more information, see - "[About community profiles for public repositories](https://docs.github.com/enterprise-cloud@latest//communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." + "[About community profiles for public repositories](https://docs.github.com/enterprise-cloud@latest/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." `content_reports_enabled` is only returned for organization-owned repositories. tags: @@ -85315,10 +86938,10 @@ paths: operationId: repos/get-community-profile-metrics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics + url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/community#get-community-profile-metrics parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -85351,11 +86974,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *584 + - *588 code_of_conduct_file: anyOf: - type: 'null' - - &585 + - &589 title: Community Health File type: object properties: @@ -85375,19 +86998,19 @@ paths: contributing: anyOf: - type: 'null' - - *585 + - *589 readme: anyOf: - type: 'null' - - *585 + - *589 issue_template: anyOf: - type: 'null' - - *585 + - *589 pull_request_template: anyOf: - type: 'null' - - *585 + - *589 required: - code_of_conduct - code_of_conduct_file @@ -85458,11 +87081,11 @@ paths: get: summary: Compare two commits description: |- - Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-cloud@latest/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.diff`**: Returns the diff of the commit. - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. @@ -85478,7 +87101,7 @@ paths: - The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison. - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results. - For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api)." + For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api)." **Signature verification object** @@ -85514,10 +87137,10 @@ paths: operationId: repos/compare-commits externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#compare-two-commits parameters: - - *461 - - *462 + - *465 + - *466 - *19 - *17 - name: basehead @@ -85565,8 +87188,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *575 - merge_base_commit: *575 + base_commit: *579 + merge_base_commit: *579 status: type: string enum: @@ -85590,10 +87213,10 @@ paths: - 6 commits: type: array - items: *575 + items: *579 files: type: array - items: *586 + items: *590 required: - url - html_url @@ -85839,12 +87462,12 @@ paths: schema: type: string examples: - default: *587 + default: *591 application/vnd.github.patch: schema: type: string examples: - default: *588 + default: *592 '404': *6 '500': *38 '503': *192 @@ -85859,7 +87482,7 @@ paths: description: |- Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -85873,9 +87496,9 @@ paths: **Notes**: - - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree). + - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-cloud@latest/rest/git/trees#get-a-tree). - This API has an upper limit of 1,000 files for a directory. If you need to retrieve - more files, use the [Git Trees API](https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree). + more files, use the [Git Trees API](https://docs.github.com/enterprise-cloud@latest/rest/git/trees#get-a-tree). - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - If the requested file's size is: - 1 MB or smaller: All features of this endpoint are supported. @@ -85887,10 +87510,10 @@ paths: operationId: repos/get-content externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-repository-content parameters: - - *461 - - *462 + - *465 + - *466 - name: path description: path parameter in: path @@ -86060,7 +87683,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &589 + response-if-content-is-a-file-github-object: &593 summary: Response if content is a file value: type: file @@ -86197,7 +87820,7 @@ paths: - size - type - url - - &706 + - &710 title: Content File description: Content File type: object @@ -86415,7 +88038,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *589 + response-if-content-is-a-file: *593 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -86484,7 +88107,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *590 + '302': *594 '304': *35 x-github: githubCloudOnly: false @@ -86497,7 +88120,7 @@ paths: Creates a new file or replaces an existing file in a repository. > [!NOTE] - > If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + > If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-cloud@latest/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. tags: @@ -86505,10 +88128,10 @@ paths: operationId: repos/create-or-update-file-contents externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#create-or-update-file-contents parameters: - - *461 - - *462 + - *465 + - *466 - name: path description: path parameter in: path @@ -86603,7 +88226,7 @@ paths: description: Response content: application/json: - schema: &591 + schema: &595 title: File Commit description: File Commit type: object @@ -86759,7 +88382,7 @@ paths: description: Response content: application/json: - schema: *591 + schema: *595 examples: example-for-creating-a-file: value: @@ -86813,7 +88436,7 @@ paths: schema: oneOf: - *3 - - &631 + - &635 description: Repository rule violation was detected type: object properties: @@ -86834,7 +88457,7 @@ paths: items: type: object properties: - placeholder_id: &746 + placeholder_id: &750 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -86858,16 +88481,16 @@ paths: You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. > [!NOTE] - > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-cloud@latest/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. tags: - repos operationId: repos/delete-file externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#delete-a-file parameters: - - *461 - - *462 + - *465 + - *466 - name: path description: path parameter in: path @@ -86928,7 +88551,7 @@ paths: description: Response content: application/json: - schema: *591 + schema: *595 examples: default: value: @@ -86981,10 +88604,10 @@ paths: operationId: repos/list-contributors externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-contributors parameters: - - *461 - - *462 + - *465 + - *466 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -87106,26 +88729,26 @@ paths: operationId: dependabot/list-alerts-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *461 - - *462 - - *328 - - *329 - - *330 - - *331 + - *465 + - *466 - *332 + - *333 + - *334 + - *335 + - *336 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *333 - - *592 - - *334 - - *335 - - *336 + - *337 + - *596 + - *338 + - *339 + - *340 - *110 - *108 - *109 @@ -87137,7 +88760,7 @@ paths: application/json: schema: type: array - items: &596 + items: &600 type: object description: A Dependabot alert. properties: @@ -87188,7 +88811,7 @@ paths: - transitive - inconclusive - - security_advisory: *593 + security_advisory: *597 security_vulnerability: *131 url: *132 html_url: *133 @@ -87219,8 +88842,8 @@ paths: dismissal. maxLength: 280 fixed_at: *137 - auto_dismissed_at: *594 - dismissal_request: *595 + auto_dismissed_at: *598 + dismissal_request: *599 assignees: type: array description: The users assigned to this alert. @@ -87473,11 +89096,11 @@ paths: operationId: dependabot/get-alert externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *461 - - *462 - - &597 + - *465 + - *466 + - &601 name: alert_number in: path description: |- @@ -87492,7 +89115,7 @@ paths: description: Response content: application/json: - schema: *596 + schema: *600 examples: default: value: @@ -87614,7 +89237,7 @@ paths: patch: summary: Update a Dependabot alert description: |- - The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." + The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: @@ -87622,11 +89245,11 @@ paths: operationId: dependabot/update-alert externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *461 - - *462 - - *597 + - *465 + - *466 + - *601 requestBody: required: true content: @@ -87682,7 +89305,7 @@ paths: description: Response content: application/json: - schema: *596 + schema: *600 examples: default: value: @@ -87810,10 +89433,10 @@ paths: operationId: dependabot/list-repo-secrets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-repository-secrets parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 responses: @@ -87831,7 +89454,7 @@ paths: type: integer secrets: type: array - items: &600 + items: &604 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -87883,18 +89506,18 @@ paths: operationId: dependabot/get-repo-public-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response content: application/json: - schema: *598 + schema: *602 examples: - default: *599 + default: *603 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87912,17 +89535,17 @@ paths: operationId: dependabot/get-repo-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-secret parameters: - - *461 - - *462 + - *465 + - *466 - *288 responses: '200': description: Response content: application/json: - schema: *600 + schema: *604 examples: default: value: @@ -87938,7 +89561,7 @@ paths: summary: Create or update a repository secret description: |- Creates or updates a repository secret with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: @@ -87946,10 +89569,10 @@ paths: operationId: dependabot/create-or-update-repo-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *461 - - *462 + - *465 + - *466 - *288 requestBody: required: true @@ -87962,7 +89585,7 @@ paths: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public - key](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key) + key](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-public-key) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: @@ -88000,10 +89623,10 @@ paths: operationId: dependabot/delete-repo-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *461 - - *462 + - *465 + - *466 - *288 responses: '204': @@ -88024,10 +89647,10 @@ paths: operationId: dependency-graph/diff-range externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits + url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *461 - - *462 + - *465 + - *466 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -88199,10 +89822,10 @@ paths: operationId: dependency-graph/export-sbom externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -88459,10 +90082,10 @@ paths: operationId: dependency-graph/fetch-sbom-report externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 - name: sbom_uuid in: path required: true @@ -88473,7 +90096,7 @@ paths: '302': description: Redirects to a temporary download URL for the completed SBOM. headers: - Location: *601 + Location: *605 '202': description: SBOM is still being processed, no content is returned. '404': *6 @@ -88492,10 +90115,10 @@ paths: operationId: dependency-graph/generate-sbom-report externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '201': description: Response @@ -88531,10 +90154,10 @@ paths: operationId: dependency-graph/create-repository-snapshot externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -88617,7 +90240,7 @@ paths: - version - url additionalProperties: false - metadata: &602 + metadata: &606 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -88656,7 +90279,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *602 + metadata: *606 resolved: type: object description: A collection of resolved package dependencies. @@ -88670,7 +90293,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *602 + metadata: *606 relationship: type: string description: A notation of whether a dependency is requested @@ -88801,10 +90424,10 @@ paths: operationId: repos/list-deployments externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#list-deployments parameters: - - *461 - - *462 + - *465 + - *466 - name: sha description: The SHA recorded at creation time. in: query @@ -88845,9 +90468,9 @@ paths: application/json: schema: type: array - items: *603 + items: *607 examples: - default: *604 + default: *608 headers: Link: *45 x-github: @@ -88872,7 +90495,7 @@ paths: the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will return a failure response. - By default, [commit statuses](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses) for every submitted context must be in a `success` + By default, [commit statuses](https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses) for every submitted context must be in a `success` state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do not require any contexts or create any commit statuses, the deployment will always succeed. @@ -88911,10 +90534,10 @@ paths: operationId: repos/create-deployment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#create-a-deployment parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -88936,7 +90559,7 @@ paths: default: true required_contexts: type: array - description: The [status](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses) + description: The [status](https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. @@ -88996,7 +90619,7 @@ paths: description: Response content: application/json: - schema: *603 + schema: *607 examples: simple-example: summary: Simple example @@ -89067,11 +90690,11 @@ paths: operationId: repos/get-deployment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#get-a-deployment parameters: - - *461 - - *462 - - &605 + - *465 + - *466 + - &609 name: deployment_id description: deployment_id parameter in: path @@ -89083,7 +90706,7 @@ paths: description: Response content: application/json: - schema: *603 + schema: *607 examples: default: value: @@ -89138,7 +90761,7 @@ paths: * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. * Mark the active deployment as inactive by adding any non-successful deployment status. - For more information, see "[Create a deployment](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status)." + For more information, see "[Create a deployment](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#create-a-deployment-status)." OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. tags: @@ -89146,11 +90769,11 @@ paths: operationId: repos/delete-deployment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#delete-a-deployment parameters: - - *461 - - *462 - - *605 + - *465 + - *466 + - *609 responses: '204': description: Response @@ -89170,11 +90793,11 @@ paths: operationId: repos/list-deployment-statuses externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#list-deployment-statuses parameters: - - *461 - - *462 - - *605 + - *465 + - *466 + - *609 - *17 - *19 responses: @@ -89184,7 +90807,7 @@ paths: application/json: schema: type: array - items: &606 + items: &610 title: Deployment Status description: The status of a deployment. type: object @@ -89346,11 +90969,11 @@ paths: operationId: repos/create-deployment-status externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#create-a-deployment-status parameters: - - *461 - - *462 - - *605 + - *465 + - *466 + - *609 requestBody: required: true content: @@ -89425,9 +91048,9 @@ paths: description: Response content: application/json: - schema: *606 + schema: *610 examples: - default: &607 + default: &611 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -89481,11 +91104,11 @@ paths: operationId: repos/get-deployment-status externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#get-a-deployment-status parameters: - - *461 - - *462 - - *605 + - *465 + - *466 + - *609 - name: status_id in: path required: true @@ -89496,9 +91119,9 @@ paths: description: Response content: application/json: - schema: *606 + schema: *610 examples: - default: *607 + default: *611 '404': *6 x-github: githubCloudOnly: false @@ -89518,19 +91141,19 @@ paths: operationId: code-scanning/list-dismissal-requests-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/alert-dismissal-requests#list-dismissal-requests-for-code-scanning-alerts-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/alert-dismissal-requests#list-dismissal-requests-for-code-scanning-alerts-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: code-scanning subcategory: alert-dismissal-requests parameters: - - *461 - - *462 - - *608 - - *609 - - *610 - - *611 + - *465 + - *466 + - *612 + - *613 + - *614 + - *615 - *17 - *19 responses: @@ -89540,9 +91163,9 @@ paths: application/json: schema: type: array - items: *612 + items: *616 examples: - default: *613 + default: *617 '404': *6 '403': *27 '500': *38 @@ -89559,15 +91182,15 @@ paths: operationId: code-scanning/get-dismissal-request-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/alert-dismissal-requests#get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/alert-dismissal-requests#get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: code-scanning subcategory: alert-dismissal-requests parameters: - - *461 - - *462 + - *465 + - *466 - name: alert_number in: path required: true @@ -89579,7 +91202,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *612 + schema: *616 examples: default: value: @@ -89628,15 +91251,15 @@ paths: operationId: code-scanning/review-dismissal-request-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/alert-dismissal-requests#review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/alert-dismissal-requests#review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: code-scanning subcategory: alert-dismissal-requests parameters: - - *461 - - *462 + - *465 + - *466 - name: alert_number in: path required: true @@ -89688,19 +91311,19 @@ paths: operationId: dependabot/list-dismissal-requests-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#list-dismissal-requests-for-dependabot-alerts-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#list-dismissal-requests-for-dependabot-alerts-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: dependabot subcategory: alert-dismissal-requests parameters: - - *461 - - *462 - - *608 - - *609 - - *610 - - *611 + - *465 + - *466 + - *612 + - *613 + - *614 + - *615 - *17 - *19 responses: @@ -89710,9 +91333,9 @@ paths: application/json: schema: type: array - items: *614 + items: *618 examples: - default: *615 + default: *619 '404': *6 '403': *27 '500': *38 @@ -89729,15 +91352,15 @@ paths: operationId: dependabot/get-dismissal-request-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#get-a-dismissal-request-for-a-dependabot-alert-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#get-a-dismissal-request-for-a-dependabot-alert-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: dependabot subcategory: alert-dismissal-requests parameters: - - *461 - - *462 + - *465 + - *466 - name: alert_number in: path required: true @@ -89749,7 +91372,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *614 + schema: *618 examples: default: value: @@ -89793,15 +91416,15 @@ paths: operationId: dependabot/create-dismissal-request-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#create-a-dismissal-request-for-a-dependabot-alert-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#create-a-dismissal-request-for-a-dependabot-alert-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: dependabot subcategory: alert-dismissal-requests parameters: - - *461 - - *462 + - *465 + - *466 - name: alert_number in: path required: true @@ -89839,7 +91462,7 @@ paths: description: The created dismissal request. content: application/json: - schema: *614 + schema: *618 examples: default: value: @@ -89883,15 +91506,15 @@ paths: operationId: dependabot/review-dismissal-request-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#review-a-dismissal-request-for-a-dependabot-alert-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#review-a-dismissal-request-for-a-dependabot-alert-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: dependabot subcategory: alert-dismissal-requests parameters: - - *461 - - *462 + - *465 + - *466 - name: alert_number in: path required: true @@ -89955,15 +91578,15 @@ paths: operationId: dependabot/cancel-dismissal-request-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alert-dismissal-requests#cancel-a-dismissal-request-for-a-dependabot-alert-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alert-dismissal-requests#cancel-a-dismissal-request-for-a-dependabot-alert-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: dependabot subcategory: alert-dismissal-requests parameters: - - *461 - - *462 + - *465 + - *466 - name: alert_number in: path required: true @@ -89989,19 +91612,19 @@ paths: operationId: secret-scanning/list-repo-dismissal-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *461 - - *462 + - *465 + - *466 - *103 - *104 - *105 - - *342 + - *346 - *17 - *19 responses: @@ -90011,9 +91634,9 @@ paths: application/json: schema: type: array - items: *344 + items: *348 examples: - default: *345 + default: *349 '404': *6 '403': *27 '500': *38 @@ -90031,15 +91654,15 @@ paths: operationId: secret-scanning/get-dismissal-request externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#get-an-alert-dismissal-request-for-secret-scanning + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/alert-dismissal-requests#get-an-alert-dismissal-request-for-secret-scanning x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *461 - - *462 + - *465 + - *466 - name: alert_number in: path required: true @@ -90051,7 +91674,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *344 + schema: *348 examples: default: value: @@ -90102,15 +91725,15 @@ paths: operationId: secret-scanning/review-dismissal-request externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#review-an-alert-dismissal-request-for-secret-scanning + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/alert-dismissal-requests#review-an-alert-dismissal-request-for-secret-scanning x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *461 - - *462 + - *465 + - *466 - name: alert_number in: path required: true @@ -90165,7 +91788,7 @@ paths: post: summary: Create a repository dispatch event description: |- - You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Cloud to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#repository_dispatch)." + You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Cloud to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#repository_dispatch)." The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. @@ -90177,10 +91800,10 @@ paths: operationId: repos/create-dispatch-event externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -90235,10 +91858,10 @@ paths: operationId: repos/get-all-environments externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#list-environments parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 responses: @@ -90256,7 +91879,7 @@ paths: - 5 environments: type: array - items: &617 + items: &621 title: Environment description: Details of a deployment environment type: object @@ -90318,7 +91941,7 @@ paths: type: string examples: - wait_timer - wait_timer: &619 + wait_timer: &623 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -90360,7 +91983,7 @@ paths: items: type: object properties: - type: *616 + type: *620 reviewer: anyOf: - *4 @@ -90387,7 +92010,7 @@ paths: - id - node_id - type - deployment_branch_policy: &620 + deployment_branch_policy: &624 type: - object - 'null' @@ -90502,11 +92125,11 @@ paths: operationId: repos/get-environment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#get-an-environment parameters: - - *461 - - *462 - - &618 + - *465 + - *466 + - &622 name: environment_name in: path required: true @@ -90519,9 +92142,9 @@ paths: description: Response content: application/json: - schema: *617 + schema: *621 examples: - default: &621 + default: &625 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -90603,11 +92226,11 @@ paths: operationId: repos/create-or-update-environment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#create-or-update-an-environment parameters: - - *461 - - *462 - - *618 + - *465 + - *466 + - *622 requestBody: required: false content: @@ -90617,7 +92240,7 @@ paths: - object - 'null' properties: - wait_timer: *619 + wait_timer: *623 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -90636,14 +92259,14 @@ paths: items: type: object properties: - type: *616 + type: *620 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *620 + deployment_branch_policy: *624 additionalProperties: false examples: default: @@ -90663,9 +92286,9 @@ paths: description: Response content: application/json: - schema: *617 + schema: *621 examples: - default: *621 + default: *625 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -90687,11 +92310,11 @@ paths: operationId: repos/delete-an-environment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#delete-an-environment parameters: - - *461 - - *462 - - *618 + - *465 + - *466 + - *622 responses: '204': description: Default response @@ -90714,11 +92337,11 @@ paths: operationId: repos/list-deployment-branch-policies externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *461 - - *462 - - *618 + - *465 + - *466 + - *622 - *17 - *19 responses: @@ -90737,7 +92360,7 @@ paths: - 2 branch_policies: type: array - items: &622 + items: &626 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -90796,11 +92419,11 @@ paths: operationId: repos/create-deployment-branch-policy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *461 - - *462 - - *618 + - *465 + - *466 + - *622 requestBody: required: true content: @@ -90848,9 +92471,9 @@ paths: description: Response content: application/json: - schema: *622 + schema: *626 examples: - example-wildcard: &623 + example-wildcard: &627 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -90890,12 +92513,12 @@ paths: operationId: repos/get-deployment-branch-policy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *461 - - *462 - - *618 - - &624 + - *465 + - *466 + - *622 + - &628 name: branch_policy_id in: path required: true @@ -90907,9 +92530,9 @@ paths: description: Response content: application/json: - schema: *622 + schema: *626 examples: - default: *623 + default: *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90926,12 +92549,12 @@ paths: operationId: repos/update-deployment-branch-policy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *461 - - *462 - - *618 - - *624 + - *465 + - *466 + - *622 + - *628 requestBody: required: true content: @@ -90960,9 +92583,9 @@ paths: description: Response content: application/json: - schema: *622 + schema: *626 examples: - default: *623 + default: *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90979,12 +92602,12 @@ paths: operationId: repos/delete-deployment-branch-policy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *461 - - *462 - - *618 - - *624 + - *465 + - *466 + - *622 + - *628 responses: '204': description: Response @@ -90997,9 +92620,9 @@ paths: get: summary: Get all deployment protection rules for an environment description: |- - Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." + Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app). + For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-app). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: @@ -91007,11 +92630,11 @@ paths: operationId: repos/get-all-deployment-protection-rules externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *618 - - *462 - - *461 + - *622 + - *466 + - *465 responses: '200': description: List of deployment protection rules @@ -91028,7 +92651,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &625 + items: &629 title: Deployment protection rule description: Deployment protection rule type: object @@ -91050,7 +92673,7 @@ paths: for the environment. examples: - true - app: &626 + app: &630 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -91143,7 +92766,7 @@ paths: The authenticated user must have admin or owner permissions to the repository to use this endpoint. - For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-cloud@latest//actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules). + For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-cloud@latest/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: @@ -91151,11 +92774,11 @@ paths: operationId: repos/create-deployment-protection-rule externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *618 - - *462 - - *461 + - *622 + - *466 + - *465 requestBody: content: application/json: @@ -91176,9 +92799,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *625 + schema: *629 examples: - default: &627 + default: &631 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -91201,9 +92824,9 @@ paths: The authenticated user must have admin or owner permissions to the repository to use this endpoint. - For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." + For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app)". + For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-app)". OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: @@ -91211,11 +92834,11 @@ paths: operationId: repos/list-custom-deployment-rule-integrations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *618 - - *462 - - *461 + - *622 + - *466 + - *465 - *19 - *17 responses: @@ -91235,7 +92858,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *626 + items: *630 examples: default: value: @@ -91258,9 +92881,9 @@ paths: get: summary: Get a custom deployment protection rule description: |- - Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." + Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app). + For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-app). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: @@ -91268,12 +92891,12 @@ paths: operationId: repos/get-custom-deployment-protection-rule externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-a-custom-deployment-protection-rule + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *461 - - *462 - - *618 - - &628 + - *465 + - *466 + - *622 + - &632 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -91285,9 +92908,9 @@ paths: description: Response content: application/json: - schema: *625 + schema: *629 examples: - default: *627 + default: *631 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91306,12 +92929,12 @@ paths: operationId: repos/disable-deployment-protection-rule externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment + url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *618 - - *462 - - *461 - - *628 + - *622 + - *466 + - *465 + - *632 responses: '204': description: Response @@ -91335,11 +92958,11 @@ paths: operationId: actions/list-environment-secrets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-environment-secrets parameters: - - *461 - - *462 - - *618 + - *465 + - *466 + - *622 - *17 - *19 responses: @@ -91357,9 +92980,9 @@ paths: type: integer secrets: type: array - items: *492 + items: *496 examples: - default: *493 + default: *497 headers: Link: *45 x-github: @@ -91382,19 +93005,19 @@ paths: operationId: actions/get-environment-public-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-public-key parameters: - - *461 - - *462 - - *618 + - *465 + - *466 + - *622 responses: '200': description: Response content: application/json: - schema: *494 + schema: *498 examples: - default: *495 + default: *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91414,20 +93037,20 @@ paths: operationId: actions/get-environment-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-secret parameters: - - *461 - - *462 - - *618 + - *465 + - *466 + - *622 - *288 responses: '200': description: Response content: application/json: - schema: *492 + schema: *496 examples: - default: *629 + default: *633 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91437,7 +93060,7 @@ paths: summary: Create or update an environment secret description: |- Creates or updates an environment secret with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." Authenticated users must have collaborator access to a repository to create, update, or read secrets. @@ -91447,11 +93070,11 @@ paths: operationId: actions/create-or-update-environment-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *461 - - *462 - - *618 + - *465 + - *466 + - *622 - *288 requestBody: required: true @@ -91464,7 +93087,7 @@ paths: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public - key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key) + key](https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-public-key) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: @@ -91507,11 +93130,11 @@ paths: operationId: actions/delete-environment-secret externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-an-environment-secret parameters: - - *461 - - *462 - - *618 + - *465 + - *466 + - *622 - *288 responses: '204': @@ -91535,12 +93158,12 @@ paths: operationId: actions/list-environment-variables externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-environment-variables parameters: - - *461 - - *462 - - *618 - - *479 + - *465 + - *466 + - *622 + - *483 - *19 responses: '200': @@ -91557,9 +93180,9 @@ paths: type: integer variables: type: array - items: *496 + items: *500 examples: - default: *497 + default: *501 headers: Link: *45 x-github: @@ -91580,11 +93203,11 @@ paths: operationId: actions/create-environment-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-an-environment-variable parameters: - - *461 - - *462 - - *618 + - *465 + - *466 + - *622 requestBody: required: true content: @@ -91634,20 +93257,20 @@ paths: operationId: actions/get-environment-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-an-environment-variable parameters: - - *461 - - *462 - - *618 + - *465 + - *466 + - *622 - *291 responses: '200': description: Response content: application/json: - schema: *496 + schema: *500 examples: - default: *630 + default: *634 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91666,12 +93289,12 @@ paths: operationId: actions/update-environment-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-an-environment-variable parameters: - - *461 - - *462 + - *465 + - *466 - *291 - - *618 + - *622 requestBody: required: true content: @@ -91711,12 +93334,12 @@ paths: operationId: actions/delete-environment-variable externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-an-environment-variable parameters: - - *461 - - *462 + - *465 + - *466 - *291 - - *618 + - *622 responses: '204': description: Response @@ -91736,10 +93359,10 @@ paths: operationId: activity/list-repo-events externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-repository-events parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 responses: @@ -91805,10 +93428,10 @@ paths: operationId: repos/list-forks externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/forks#list-forks parameters: - - *461 - - *462 + - *465 + - *466 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -91965,10 +93588,10 @@ paths: operationId: repos/create-fork externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/forks#create-a-fork parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: false content: @@ -92001,9 +93624,9 @@ paths: description: Response content: application/json: - schema: *466 + schema: *470 examples: - default: *468 + default: *472 '400': *14 '422': *15 '403': *27 @@ -92022,10 +93645,10 @@ paths: operationId: git/create-blob externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob + url: https://docs.github.com/enterprise-cloud@latest/rest/git/blobs#create-a-blob parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -92085,7 +93708,7 @@ paths: schema: oneOf: - *253 - - *631 + - *635 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92097,7 +93720,7 @@ paths: description: |- The `content` in the response will always be Base64 encoded. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw blob data. - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. @@ -92108,10 +93731,10 @@ paths: operationId: git/get-blob externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob + url: https://docs.github.com/enterprise-cloud@latest/rest/git/blobs#get-a-blob parameters: - - *461 - - *462 + - *465 + - *466 - name: file_sha in: path required: true @@ -92209,10 +93832,10 @@ paths: operationId: git/create-commit externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit + url: https://docs.github.com/enterprise-cloud@latest/rest/git/commits#create-a-commit parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -92321,7 +93944,7 @@ paths: description: Response content: application/json: - schema: &632 + schema: &636 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -92546,17 +94169,17 @@ paths: operationId: git/get-commit externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object + url: https://docs.github.com/enterprise-cloud@latest/rest/git/commits#get-a-commit-object parameters: - - *461 - - *462 - - *576 + - *465 + - *466 + - *580 responses: '200': description: Response content: application/json: - schema: *632 + schema: *636 examples: default: value: @@ -92602,7 +94225,7 @@ paths: When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. > [!NOTE] - > You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + > You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. tags: @@ -92610,11 +94233,11 @@ paths: operationId: git/list-matching-refs externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references + url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#list-matching-references parameters: - - *461 - - *462 - - &633 + - *465 + - *466 + - &637 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -92631,7 +94254,7 @@ paths: application/json: schema: type: array - items: &634 + items: &638 title: Git Reference description: Git references within a repository type: object @@ -92699,25 +94322,25 @@ paths: Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. > [!NOTE] - > You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + > You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". tags: - git operationId: git/get-ref externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference + url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference parameters: - - *461 - - *462 - - *633 + - *465 + - *466 + - *637 responses: '200': description: Response content: application/json: - schema: *634 + schema: *638 examples: - default: &635 + default: &639 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -92744,10 +94367,10 @@ paths: operationId: git/create-ref externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference + url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#create-a-reference parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -92776,9 +94399,9 @@ paths: description: Response content: application/json: - schema: *634 + schema: *638 examples: - default: *635 + default: *639 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -92802,11 +94425,11 @@ paths: operationId: git/update-ref externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference + url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#update-a-reference parameters: - - *461 - - *462 - - *633 + - *465 + - *466 + - *637 requestBody: required: true content: @@ -92835,9 +94458,9 @@ paths: description: Response content: application/json: - schema: *634 + schema: *638 examples: - default: *635 + default: *639 '422': *15 '409': *119 x-github: @@ -92853,11 +94476,11 @@ paths: operationId: git/delete-ref externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference + url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#delete-a-reference parameters: - - *461 - - *462 - - *633 + - *465 + - *466 + - *637 responses: '204': description: Response @@ -92874,7 +94497,7 @@ paths: post: summary: Create a tag object description: |- - Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. + Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. **Signature verification object** @@ -92910,10 +94533,10 @@ paths: operationId: git/create-tag externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object + url: https://docs.github.com/enterprise-cloud@latest/rest/git/tags#create-a-tag-object parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -92980,7 +94603,7 @@ paths: description: Response content: application/json: - schema: &637 + schema: &641 title: Git Tag description: Metadata for a Git tag type: object @@ -93036,7 +94659,7 @@ paths: - sha - type - url - verification: *636 + verification: *640 required: - sha - url @@ -93046,7 +94669,7 @@ paths: - tag - message examples: - default: &638 + default: &642 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -93117,10 +94740,10 @@ paths: operationId: git/get-tag externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag + url: https://docs.github.com/enterprise-cloud@latest/rest/git/tags#get-a-tag parameters: - - *461 - - *462 + - *465 + - *466 - name: tag_sha in: path required: true @@ -93131,9 +94754,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *641 examples: - default: *638 + default: *642 '404': *6 '409': *119 x-github: @@ -93147,7 +94770,7 @@ paths: description: |- The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. - If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference)." + If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-cloud@latest/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#update-a-reference)." Returns an error if you try to delete a file that does not exist. tags: @@ -93155,10 +94778,10 @@ paths: operationId: git/create-tree externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree + url: https://docs.github.com/enterprise-cloud@latest/rest/git/trees#create-a-tree parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -93232,7 +94855,7 @@ paths: description: Response content: application/json: - schema: &639 + schema: &643 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -93332,10 +94955,10 @@ paths: operationId: git/get-tree externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree + url: https://docs.github.com/enterprise-cloud@latest/rest/git/trees#get-a-tree parameters: - - *461 - - *462 + - *465 + - *466 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -93358,7 +94981,7 @@ paths: description: Response content: application/json: - schema: *639 + schema: *643 examples: default-response: summary: Default response @@ -93415,10 +95038,10 @@ paths: operationId: repos/list-webhooks externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#list-repository-webhooks parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 responses: @@ -93428,7 +95051,7 @@ paths: application/json: schema: type: array - items: &640 + items: &644 title: Webhook description: Webhooks for repositories. type: object @@ -93491,7 +95114,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &890 + last_response: &895 title: Hook Response type: object properties: @@ -93566,10 +95189,10 @@ paths: operationId: repos/create-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#create-a-repository-webhook parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: false content: @@ -93593,7 +95216,7 @@ paths: insecure_ssl: *11 events: type: array - description: Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) + description: Determines what [events](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads) the hook is triggered for. default: - push @@ -93622,9 +95245,9 @@ paths: description: Response content: application/json: - schema: *640 + schema: *644 examples: - default: &641 + default: &645 value: type: Repository id: 12345678 @@ -93670,19 +95293,19 @@ paths: operationId: repos/get-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-repository-webhook parameters: - - *461 - - *462 - - *348 + - *465 + - *466 + - *352 responses: '200': description: Response content: application/json: - schema: *640 + schema: *644 examples: - default: *641 + default: *645 '404': *6 x-github: githubCloudOnly: false @@ -93700,11 +95323,11 @@ paths: operationId: repos/update-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#update-a-repository-webhook parameters: - - *461 - - *462 - - *348 + - *465 + - *466 + - *352 requestBody: required: true content: @@ -93715,7 +95338,7 @@ paths: config: *12 events: type: array - description: Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) + description: Determines what [events](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. default: - push @@ -93749,9 +95372,9 @@ paths: description: Response content: application/json: - schema: *640 + schema: *644 examples: - default: *641 + default: *645 '422': *15 '404': *6 x-github: @@ -93770,11 +95393,11 @@ paths: operationId: repos/delete-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *461 - - *462 - - *348 + - *465 + - *466 + - *352 responses: '204': description: Response @@ -93796,11 +95419,11 @@ paths: operationId: repos/get-webhook-config-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-webhook-configuration-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *461 - - *462 - - *348 + - *465 + - *466 + - *352 responses: '200': description: Response @@ -93825,11 +95448,11 @@ paths: operationId: repos/update-webhook-config-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-webhook-configuration-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *461 - - *462 - - *348 + - *465 + - *466 + - *352 requestBody: required: false content: @@ -93871,14 +95494,14 @@ paths: operationId: repos/list-webhook-deliveries externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *461 - - *462 - - *348 + - *465 + - *466 + - *352 - *17 - - *349 - - *350 + - *353 + - *354 responses: '200': description: Response @@ -93886,9 +95509,9 @@ paths: application/json: schema: type: array - items: *351 + items: *355 examples: - default: *352 + default: *356 '400': *14 '422': *15 x-github: @@ -93905,20 +95528,20 @@ paths: operationId: repos/get-webhook-delivery externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-delivery-for-a-repository-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *461 - - *462 - - *348 + - *465 + - *466 + - *352 - *16 responses: '200': description: Response content: application/json: - schema: *353 + schema: *357 examples: - default: *354 + default: *358 '400': *14 '422': *15 x-github: @@ -93935,11 +95558,11 @@ paths: operationId: repos/redeliver-webhook-delivery externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *461 - - *462 - - *348 + - *465 + - *466 + - *352 - *16 responses: '202': *37 @@ -93953,18 +95576,18 @@ paths: "/repos/{owner}/{repo}/hooks/{hook_id}/pings": post: summary: Ping a repository webhook - description: This will trigger a [ping event](https://docs.github.com/enterprise-cloud@latest//webhooks/#ping-event) + description: This will trigger a [ping event](https://docs.github.com/enterprise-cloud@latest/webhooks/#ping-event) to be sent to the hook. tags: - repos operationId: repos/ping-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *461 - - *462 - - *348 + - *465 + - *466 + - *352 responses: '204': description: Response @@ -93987,11 +95610,11 @@ paths: operationId: repos/test-push-webhook externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *461 - - *462 - - *348 + - *465 + - *466 + - *352 responses: '204': description: Response @@ -94012,10 +95635,10 @@ paths: operationId: repos/check-immutable-releases externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response if immutable releases are enabled @@ -94061,10 +95684,10 @@ paths: operationId: repos/enable-immutable-releases externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-immutable-releases parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': *126 '409': *119 @@ -94082,10 +95705,10 @@ paths: operationId: repos/disable-immutable-releases externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-immutable-releases parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': *126 '409': *119 @@ -94117,11 +95740,11 @@ paths: If there are problems, you will see one of these in the `status` field: - * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section. + * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import) section. * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information. - * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section. - * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import) with the correct URL. - * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section. + * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import) section. + * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#start-an-import) with the correct URL. + * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import) section. **The project_choices field** @@ -94140,16 +95763,16 @@ paths: operationId: migrations/get-import-status externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-an-import-status parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response content: application/json: - schema: &642 + schema: &646 title: Import description: A repository import from an external source. type: object @@ -94256,7 +95879,7 @@ paths: - html_url - authors_url examples: - default: &645 + default: &649 value: vcs: subversion use_lfs: true @@ -94272,7 +95895,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &643 + '503': &647 description: Unavailable due to service under maintenance. content: application/json: @@ -94299,10 +95922,10 @@ paths: operationId: migrations/start-import externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#start-an-import parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -94350,7 +95973,7 @@ paths: description: Response content: application/json: - schema: *642 + schema: *646 examples: default: value: @@ -94375,7 +95998,7 @@ paths: type: string '422': *15 '404': *6 - '503': *643 + '503': *647 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94401,10 +96024,10 @@ paths: operationId: migrations/update-import externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: false content: @@ -94456,7 +96079,7 @@ paths: description: Response content: application/json: - schema: *642 + schema: *646 examples: example-1: summary: Example 1 @@ -94504,7 +96127,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *643 + '503': *647 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94525,14 +96148,14 @@ paths: operationId: migrations/cancel-import externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#cancel-an-import parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': description: Response - '503': *643 + '503': *647 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94547,7 +96170,7 @@ paths: description: |- Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. - This endpoint and the [Map a commit author](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. + This endpoint and the [Map a commit author](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. > [!WARNING] > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). @@ -94556,11 +96179,11 @@ paths: operationId: migrations/get-commit-authors externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-commit-authors parameters: - - *461 - - *462 - - &821 + - *465 + - *466 + - &825 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -94574,7 +96197,7 @@ paths: application/json: schema: type: array - items: &644 + items: &648 title: Porter Author description: Porter Author type: object @@ -94628,7 +96251,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *643 + '503': *647 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94651,10 +96274,10 @@ paths: operationId: migrations/map-commit-author externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#map-a-commit-author parameters: - - *461 - - *462 + - *465 + - *466 - name: author_id in: path required: true @@ -94684,7 +96307,7 @@ paths: description: Response content: application/json: - schema: *644 + schema: *648 examples: default: value: @@ -94697,7 +96320,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *643 + '503': *647 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94719,10 +96342,10 @@ paths: operationId: migrations/get-large-files externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-large-files parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -94763,7 +96386,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *643 + '503': *647 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94780,7 +96403,7 @@ paths: is powered by [Git LFS](https://git-lfs.com). You can learn more about our LFS feature and working with large files [on our help - site](https://docs.github.com/enterprise-cloud@latest//repositories/working-with-files/managing-large-files). + site](https://docs.github.com/enterprise-cloud@latest/repositories/working-with-files/managing-large-files). > [!WARNING] > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). @@ -94789,10 +96412,10 @@ paths: operationId: migrations/set-lfs-preference externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -94819,11 +96442,11 @@ paths: description: Response content: application/json: - schema: *642 + schema: *646 examples: - default: *645 + default: *649 '422': *15 - '503': *643 + '503': *647 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94838,16 +96461,16 @@ paths: description: |- Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-repo-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-repository-installation-for-the-authenticated-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -94855,8 +96478,8 @@ paths: application/json: schema: *20 examples: - default: *366 - '301': *467 + default: *370 + '301': *471 '404': *6 x-github: githubCloudOnly: false @@ -94874,10 +96497,10 @@ paths: operationId: interactions/get-restrictions-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -94885,12 +96508,12 @@ paths: application/json: schema: anyOf: - - *368 + - *372 - type: object properties: {} additionalProperties: false examples: - default: &647 + default: &651 value: limit: collaborators_only origin: repository @@ -94913,15 +96536,15 @@ paths: operationId: interactions/set-restrictions-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: application/json: - schema: *646 + schema: *650 examples: default: summary: Example request body @@ -94933,9 +96556,9 @@ paths: description: Response content: application/json: - schema: *368 + schema: *372 examples: - default: *647 + default: *651 '409': description: Response x-github: @@ -94955,10 +96578,10 @@ paths: operationId: interactions/remove-restrictions-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': description: Response @@ -94979,10 +96602,10 @@ paths: operationId: repos/list-invitations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#list-repository-invitations parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 responses: @@ -94992,9 +96615,9 @@ paths: application/json: schema: type: array - items: *648 + items: *652 examples: - default: &814 + default: &818 value: - id: 1 repository: @@ -95123,11 +96746,11 @@ paths: operationId: repos/update-invitation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *461 - - *462 - - *372 + - *465 + - *466 + - *376 requestBody: required: false content: @@ -95156,7 +96779,7 @@ paths: description: Response content: application/json: - schema: *648 + schema: *652 examples: default: value: @@ -95285,11 +96908,11 @@ paths: operationId: repos/delete-invitation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *461 - - *462 - - *372 + - *465 + - *466 + - *376 responses: '204': description: Response @@ -95305,9 +96928,9 @@ paths: List issues in a repository. Only open issues will be listed. > [!NOTE] - > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests)" endpoint. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95318,10 +96941,10 @@ paths: operationId: issues/list-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-repository-issues parameters: - - *461 - - *462 + - *465 + - *466 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -95369,7 +96992,7 @@ paths: required: false schema: type: string - - *379 + - *383 - name: sort description: What to sort results by. in: query @@ -95394,7 +97017,7 @@ paths: type: array items: *219 examples: - default: &657 + default: &661 value: - id: 1 node_id: MDU6SXNzdWUx @@ -95543,7 +97166,7 @@ paths: state_reason: completed headers: Link: *45 - '301': *467 + '301': *471 '422': *15 '404': *6 x-github: @@ -95554,12 +97177,12 @@ paths: post: summary: Create an issue description: |- - Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-cloud@latest//articles/disabling-issues/), the API returns a `410 Gone` status. + Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-cloud@latest/articles/disabling-issues/), the API returns a `410 Gone` status. - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95570,10 +97193,10 @@ paths: operationId: issues/create externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#create-an-issue parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -95665,7 +97288,7 @@ paths: application/json: schema: *219 examples: - default: &654 + default: &658 value: id: 1 node_id: MDU6SXNzdWUx @@ -95822,7 +97445,7 @@ paths: '422': *15 '503': *192 '404': *6 - '410': *649 + '410': *653 x-github: triggersNotification: true githubCloudOnly: false @@ -95837,7 +97460,7 @@ paths: By default, issue comments are ordered by ascending ID. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95848,10 +97471,10 @@ paths: operationId: issues/list-comments-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 - *241 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -95874,7 +97497,7 @@ paths: type: array items: *220 examples: - default: &656 + default: &660 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -95919,7 +97542,7 @@ paths: description: |- You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95930,10 +97553,10 @@ paths: operationId: issues/get-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment parameters: - - *461 - - *462 + - *465 + - *466 - *233 responses: '200': @@ -95942,7 +97565,7 @@ paths: application/json: schema: *220 examples: - default: &650 + default: &654 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -95984,7 +97607,7 @@ paths: description: |- You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95995,10 +97618,10 @@ paths: operationId: issues/update-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#update-an-issue-comment parameters: - - *461 - - *462 + - *465 + - *466 - *233 requestBody: required: true @@ -96023,7 +97646,7 @@ paths: application/json: schema: *220 examples: - default: *650 + default: *654 '422': *15 x-github: githubCloudOnly: false @@ -96039,10 +97662,10 @@ paths: operationId: issues/delete-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#delete-an-issue-comment parameters: - - *461 - - *462 + - *465 + - *466 - *233 responses: '204': @@ -96058,7 +97681,7 @@ paths: description: |- You can use the REST API to pin comments on issues. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -96069,10 +97692,10 @@ paths: operationId: issues/pin-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#pin-an-issue-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#pin-an-issue-comment parameters: - - *461 - - *462 + - *465 + - *466 - *233 responses: '200': @@ -96135,7 +97758,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *649 + '410': *653 '422': *15 x-github: githubCloudOnly: false @@ -96150,10 +97773,10 @@ paths: operationId: issues/unpin-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#unpin-an-issue-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#unpin-an-issue-comment parameters: - - *461 - - *462 + - *465 + - *466 - *233 responses: '204': @@ -96161,7 +97784,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *649 + '410': *653 '503': *192 x-github: githubCloudOnly: false @@ -96171,19 +97794,19 @@ paths: "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": get: summary: List reactions for an issue comment - description: List the reactions to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment). + description: List the reactions to an [issue comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment). tags: - reactions operationId: reactions/list-for-issue-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *461 - - *462 + - *465 + - *466 - *233 - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). + description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. in: query required: false @@ -96207,9 +97830,9 @@ paths: application/json: schema: type: array - items: *573 + items: *577 examples: - default: *651 + default: *655 headers: Link: *45 '404': *6 @@ -96220,7 +97843,7 @@ paths: subcategory: reactions post: summary: Create reaction for an issue comment - description: Create a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment). + description: Create a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. tags: @@ -96228,10 +97851,10 @@ paths: operationId: reactions/create-for-issue-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *461 - - *462 + - *465 + - *466 - *233 requestBody: required: true @@ -96242,7 +97865,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) + description: The [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions) to add to the issue comment. enum: - "+1" @@ -96264,16 +97887,16 @@ paths: description: Reaction exists content: application/json: - schema: *573 + schema: *577 examples: - default: *574 + default: *578 '201': description: Reaction created content: application/json: - schema: *573 + schema: *577 examples: - default: *574 + default: *578 '422': *15 x-github: githubCloudOnly: false @@ -96287,18 +97910,18 @@ paths: > [!NOTE] > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. - Delete a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment). + Delete a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment). tags: - reactions operationId: reactions/delete-for-issue-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *461 - - *462 + - *465 + - *466 - *233 - - *652 + - *656 responses: '204': description: Response @@ -96316,10 +97939,10 @@ paths: operationId: issues/list-events-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#list-issue-events-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 responses: @@ -96329,7 +97952,7 @@ paths: application/json: schema: type: array - items: &653 + items: &657 title: Issue Event description: Issue Event type: object @@ -96667,10 +98290,10 @@ paths: operationId: issues/get-event externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#get-an-issue-event parameters: - - *461 - - *462 + - *465 + - *466 - name: event_id in: path required: true @@ -96681,7 +98304,7 @@ paths: description: Response content: application/json: - schema: *653 + schema: *657 examples: default: value: @@ -96874,7 +98497,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *649 + '410': *653 '403': *27 x-github: githubCloudOnly: false @@ -96885,17 +98508,17 @@ paths: get: summary: Get an issue description: |- - The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was - [transferred](https://docs.github.com/enterprise-cloud@latest//articles/transferring-an-issue-to-another-repository/) to another repository. If + The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was + [transferred](https://docs.github.com/enterprise-cloud@latest/articles/transferring-an-issue-to-another-repository/) to another repository. If the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe - to the [`issues`](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#issues) webhook. + to the [`issues`](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#issues) webhook. > [!NOTE] - > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests)" endpoint. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -96906,11 +98529,11 @@ paths: operationId: issues/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue parameters: - - *461 - - *462 - - &655 + - *465 + - *466 + - &659 name: issue_number description: The number that identifies the issue. in: path @@ -96926,7 +98549,7 @@ paths: examples: default: summary: Issue - value: *654 + value: *658 pinned_comment: summary: Issue with pinned comment value: @@ -97125,9 +98748,9 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed - '301': *467 + '301': *471 '404': *6 - '410': *649 + '410': *653 '304': *35 x-github: githubCloudOnly: false @@ -97139,7 +98762,7 @@ paths: description: |- Issue owners and users with push access or Triage role can edit an issue. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97150,11 +98773,11 @@ paths: operationId: issues/update externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#update-an-issue parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 requestBody: required: false content: @@ -97295,13 +98918,13 @@ paths: application/json: schema: *219 examples: - default: *654 + default: *658 '422': *15 '503': *192 '403': *27 - '301': *467 + '301': *471 '404': *6 - '410': *649 + '410': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97317,11 +98940,11 @@ paths: operationId: issues/add-assignees externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 requestBody: required: false content: @@ -97349,7 +98972,7 @@ paths: application/json: schema: *219 examples: - default: *654 + default: *658 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97363,11 +98986,11 @@ paths: operationId: issues/remove-assignees externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 requestBody: content: application/json: @@ -97394,7 +99017,7 @@ paths: application/json: schema: *219 examples: - default: *654 + default: *658 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97414,11 +99037,11 @@ paths: operationId: issues/check-user-can-be-assigned-to-issue externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 - name: assignee in: path required: true @@ -97445,7 +99068,7 @@ paths: Issue comments are ordered by ascending ID. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97456,11 +99079,11 @@ paths: operationId: issues/list-comments externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#list-issue-comments parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 - *224 - *17 - *19 @@ -97473,11 +99096,11 @@ paths: type: array items: *220 examples: - default: *656 + default: *660 headers: Link: *45 '404': *6 - '410': *649 + '410': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97488,12 +99111,12 @@ paths: description: |- You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. - For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97504,11 +99127,11 @@ paths: operationId: issues/create-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#create-an-issue-comment parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 requestBody: required: true content: @@ -97532,14 +99155,14 @@ paths: application/json: schema: *220 examples: - default: *650 + default: *654 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *649 + '410': *653 '422': *15 '404': *6 x-github: @@ -97554,7 +99177,7 @@ paths: description: |- You can use the REST API to list the dependencies an issue is blocked by. - This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. @@ -97565,11 +99188,11 @@ paths: operationId: issues/list-dependencies-blocked-by externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 - *17 - *19 responses: @@ -97581,12 +99204,12 @@ paths: type: array items: *219 examples: - default: *657 + default: *661 headers: Link: *45 - '301': *467 + '301': *471 '404': *6 - '410': *649 + '410': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97598,10 +99221,10 @@ paths: You can use the REST API to add a 'blocked by' relationship to an issue. Creating content too quickly using this endpoint may result in secondary rate limiting. - For more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) - and [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api). + For more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api). - This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. @@ -97612,11 +99235,11 @@ paths: operationId: issues/add-blocked-by-dependency externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 requestBody: required: true content: @@ -97640,15 +99263,15 @@ paths: application/json: schema: *219 examples: - default: *654 + default: *658 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *467 + '301': *471 '403': *27 - '410': *649 + '410': *653 '422': *15 '404': *6 x-github: @@ -97664,10 +99287,10 @@ paths: You can use the REST API to remove a dependency that an issue is blocked by. Removing content too quickly using this endpoint may result in secondary rate limiting. - For more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) - and [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api). + For more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api). - This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. @@ -97677,11 +99300,11 @@ paths: operationId: issues/remove-dependency-blocked-by externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -97695,13 +99318,13 @@ paths: application/json: schema: *219 examples: - default: *654 - '301': *467 + default: *658 + '301': *471 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *649 + '410': *653 x-github: triggersNotification: true githubCloudOnly: false @@ -97714,7 +99337,7 @@ paths: description: |- You can use the REST API to list the dependencies an issue is blocking. - This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. @@ -97725,11 +99348,11 @@ paths: operationId: issues/list-dependencies-blocking externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 - *17 - *19 responses: @@ -97741,12 +99364,12 @@ paths: type: array items: *219 examples: - default: *657 + default: *661 headers: Link: *45 - '301': *467 + '301': *471 '404': *6 - '410': *649 + '410': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97761,11 +99384,11 @@ paths: operationId: issues/list-events externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#list-issue-events parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 - *17 - *19 responses: @@ -97779,7 +99402,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &661 + - &665 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -97828,7 +99451,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &662 + - &666 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -97956,7 +99579,7 @@ paths: - performed_via_github_app - assignee - assigner - - &663 + - &667 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -98002,7 +99625,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &664 + - &668 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -98048,7 +99671,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &665 + - &669 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -98097,7 +99720,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &666 + - &670 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -98139,7 +99762,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &667 + - &671 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -98181,7 +99804,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &668 + - &672 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -98237,7 +99860,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &669 + - &673 title: Locked Issue Event description: Locked Issue Event type: object @@ -98282,7 +99905,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &670 + - &674 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -98343,7 +99966,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &671 + - &675 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -98404,7 +100027,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &672 + - &676 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -98465,7 +100088,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &673 + - &677 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -98558,7 +100181,7 @@ paths: color: red headers: Link: *45 - '410': *649 + '410': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98573,11 +100196,11 @@ paths: operationId: issues/list-issue-field-values-for-issue externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#list-issue-field-values-for-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#list-issue-field-values-for-an-issue parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 - *17 - *19 responses: @@ -98587,9 +100210,9 @@ paths: application/json: schema: type: array - items: *658 + items: *662 examples: - default: &659 + default: &663 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -98613,9 +100236,9 @@ paths: value: '2025-12-25' headers: Link: *45 - '301': *467 + '301': *471 '404': *6 - '410': *649 + '410': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98635,18 +100258,18 @@ paths: Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." tags: - issues operationId: issues/add-issue-field-values externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#add-issue-field-values-to-an-issue parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 requestBody: required: true content: @@ -98712,9 +100335,9 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *658 + items: *662 examples: - default: *659 + default: *663 '400': *14 '403': *27 '404': *6 @@ -98741,18 +100364,18 @@ paths: Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." tags: - issues operationId: issues/set-issue-field-values externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#set-issue-field-values-for-an-issue parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 requestBody: required: true content: @@ -98819,9 +100442,9 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *658 + items: *662 examples: - default: *659 + default: *663 '400': *14 '403': *27 '404': *6 @@ -98843,19 +100466,19 @@ paths: If the specified field does not have a value set on the issue, this operation will return a `404` error. - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." tags: - issues operationId: issues/delete-issue-field-value externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue parameters: - - *461 - - *462 - - *655 - - *375 + - *465 + - *466 + - *659 + - *379 responses: '204': description: Issue field value deleted successfully @@ -98878,11 +100501,11 @@ paths: operationId: issues/list-labels-on-issue externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-an-issue parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 - *17 - *19 responses: @@ -98894,7 +100517,7 @@ paths: type: array items: *218 examples: - default: &660 + default: &664 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -98912,9 +100535,9 @@ paths: default: false headers: Link: *45 - '301': *467 + '301': *471 '404': *6 - '410': *649 + '410': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98928,11 +100551,11 @@ paths: operationId: issues/add-labels externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#add-labels-to-an-issue parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 requestBody: required: false content: @@ -98948,7 +100571,7 @@ paths: labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use "[Set labels for - an issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue)." + an issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#set-labels-for-an-issue)." items: type: string - type: array @@ -98977,10 +100600,10 @@ paths: type: array items: *218 examples: - default: *660 - '301': *467 + default: *664 + '301': *471 '404': *6 - '410': *649 + '410': *653 '422': *15 x-github: githubCloudOnly: false @@ -98995,11 +100618,11 @@ paths: operationId: issues/set-labels externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#set-labels-for-an-issue parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 requestBody: required: false content: @@ -99017,7 +100640,7 @@ paths: a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. - For more information, see "[Add labels to an issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue)." + For more information, see "[Add labels to an issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#add-labels-to-an-issue)." items: type: string - type: array @@ -99061,10 +100684,10 @@ paths: type: array items: *218 examples: - default: *660 - '301': *467 + default: *664 + '301': *471 '404': *6 - '410': *649 + '410': *653 '422': *15 x-github: githubCloudOnly: false @@ -99079,17 +100702,17 @@ paths: operationId: issues/remove-all-labels externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 responses: '204': description: Response - '301': *467 + '301': *471 '404': *6 - '410': *649 + '410': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99106,11 +100729,11 @@ paths: operationId: issues/remove-label externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 - name: name in: path required: true @@ -99134,9 +100757,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *467 + '301': *471 '404': *6 - '410': *649 + '410': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99148,17 +100771,17 @@ paths: description: |- Users with push access can lock an issue or pull request's conversation. - Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - issues operationId: issues/lock externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#lock-an-issue parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 requestBody: required: false content: @@ -99187,7 +100810,7 @@ paths: '204': description: Response '403': *27 - '410': *649 + '410': *653 '404': *6 '422': *15 x-github: @@ -99203,11 +100826,11 @@ paths: operationId: issues/unlock externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#unlock-an-issue parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 responses: '204': description: Response @@ -99224,7 +100847,7 @@ paths: description: |- You can use the REST API to get the parent issue of a sub-issue. - This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -99235,11 +100858,11 @@ paths: operationId: issues/get-parent externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#get-parent-issue parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 responses: '200': description: Response @@ -99247,10 +100870,10 @@ paths: application/json: schema: *219 examples: - default: *654 - '301': *467 + default: *658 + '301': *471 '404': *6 - '410': *649 + '410': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99259,19 +100882,19 @@ paths: "/repos/{owner}/{repo}/issues/{issue_number}/reactions": get: summary: List reactions for an issue - description: List the reactions to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue). + description: List the reactions to an [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue). tags: - reactions operationId: reactions/list-for-issue externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). + description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. in: query required: false @@ -99295,13 +100918,13 @@ paths: application/json: schema: type: array - items: *573 + items: *577 examples: - default: *651 + default: *655 headers: Link: *45 '404': *6 - '410': *649 + '410': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99309,7 +100932,7 @@ paths: subcategory: reactions post: summary: Create reaction for an issue - description: Create a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue). + description: Create a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. tags: @@ -99317,11 +100940,11 @@ paths: operationId: reactions/create-for-issue externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 requestBody: required: true content: @@ -99331,7 +100954,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) + description: The [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions) to add to the issue. enum: - "+1" @@ -99353,16 +100976,16 @@ paths: description: Response content: application/json: - schema: *573 + schema: *577 examples: - default: *574 + default: *578 '201': description: Response content: application/json: - schema: *573 + schema: *577 examples: - default: *574 + default: *578 '422': *15 x-github: githubCloudOnly: false @@ -99376,18 +100999,18 @@ paths: > [!NOTE] > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. - Delete a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue). + Delete a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue). tags: - reactions operationId: reactions/delete-for-issue externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *461 - - *462 - - *655 - - *652 + - *465 + - *466 + - *659 + - *656 responses: '204': description: Response @@ -99402,9 +101025,9 @@ paths: description: |- You can use the REST API to remove a sub-issue from an issue. Removing content too quickly using this endpoint may result in secondary rate limiting. - For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. @@ -99414,11 +101037,11 @@ paths: operationId: issues/remove-sub-issue externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#remove-sub-issue parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 requestBody: required: true content: @@ -99442,7 +101065,7 @@ paths: application/json: schema: *219 examples: - default: *654 + default: *658 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -99462,7 +101085,7 @@ paths: description: |- You can use the REST API to list the sub-issues on an issue. - This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. @@ -99473,11 +101096,11 @@ paths: operationId: issues/list-sub-issues externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#list-sub-issues parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 - *17 - *19 responses: @@ -99489,11 +101112,11 @@ paths: type: array items: *219 examples: - default: *657 + default: *661 headers: Link: *45 '404': *6 - '410': *649 + '410': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99505,10 +101128,10 @@ paths: You can use the REST API to add sub-issues to issues. Creating content too quickly using this endpoint may result in secondary rate limiting. - For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -99519,11 +101142,11 @@ paths: operationId: issues/add-sub-issue externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#add-sub-issue parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 requestBody: required: true content: @@ -99552,14 +101175,14 @@ paths: application/json: schema: *219 examples: - default: *654 + default: *658 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *649 + '410': *653 '422': *15 '404': *6 x-github: @@ -99577,11 +101200,11 @@ paths: operationId: issues/reprioritize-sub-issue externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 requestBody: required: true content: @@ -99614,7 +101237,7 @@ paths: application/json: schema: *219 examples: - default: *654 + default: *658 '403': *27 '404': *6 '422': *7 @@ -99634,11 +101257,11 @@ paths: operationId: issues/list-events-for-timeline externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *461 - - *462 - - *655 + - *465 + - *466 + - *659 - *17 - *19 responses: @@ -99653,10 +101276,6 @@ paths: description: Timeline Event type: object anyOf: - - *661 - - *662 - - *663 - - *664 - *665 - *666 - *667 @@ -99666,6 +101285,10 @@ paths: - *671 - *672 - *673 + - *674 + - *675 + - *676 + - *677 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -99722,7 +101345,7 @@ paths: pin: anyOf: - type: 'null' - - *674 + - *678 required: - event - actor @@ -99998,7 +101621,7 @@ paths: type: string comments: type: array - items: &695 + items: &699 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -100239,7 +101862,7 @@ paths: type: string comments: type: array - items: *572 + items: *576 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -100514,7 +102137,7 @@ paths: headers: Link: *45 '404': *6 - '410': *649 + '410': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100529,10 +102152,10 @@ paths: operationId: repos/list-deploy-keys externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys + url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 responses: @@ -100542,7 +102165,7 @@ paths: application/json: schema: type: array - items: &675 + items: &679 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -100608,10 +102231,10 @@ paths: operationId: repos/create-deploy-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key + url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -100632,8 +102255,8 @@ paths: \ \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository - permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//articles/repository-permission-levels-for-an-organization/)\" - and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-cloud@latest//articles/permission-levels-for-a-user-account-repository/).\"" + permission levels for an organization](https://docs.github.com/enterprise-cloud@latest/articles/repository-permission-levels-for-an-organization/)\" + and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-cloud@latest/articles/permission-levels-for-a-user-account-repository/).\"" required: - key examples: @@ -100647,9 +102270,9 @@ paths: description: Response content: application/json: - schema: *675 + schema: *679 examples: - default: &676 + default: &680 value: id: 1 key: ssh-rsa AAA... @@ -100681,11 +102304,11 @@ paths: operationId: repos/get-deploy-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key + url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *461 - - *462 - - &677 + - *465 + - *466 + - &681 name: key_id description: The unique identifier of the key. in: path @@ -100697,9 +102320,9 @@ paths: description: Response content: application/json: - schema: *675 + schema: *679 examples: - default: *676 + default: *680 '404': *6 x-github: githubCloudOnly: false @@ -100715,11 +102338,11 @@ paths: operationId: repos/delete-deploy-key externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key + url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *461 - - *462 - - *677 + - *465 + - *466 + - *681 responses: '204': description: Response @@ -100737,10 +102360,10 @@ paths: operationId: issues/list-labels-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 responses: @@ -100752,7 +102375,7 @@ paths: type: array items: *218 examples: - default: *660 + default: *664 headers: Link: *45 '404': *6 @@ -100771,10 +102394,10 @@ paths: operationId: issues/create-label externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#create-a-label parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -100812,7 +102435,7 @@ paths: application/json: schema: *218 examples: - default: &678 + default: &682 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -100842,10 +102465,10 @@ paths: operationId: issues/get-label externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#get-a-label parameters: - - *461 - - *462 + - *465 + - *466 - name: name in: path required: true @@ -100858,7 +102481,7 @@ paths: application/json: schema: *218 examples: - default: *678 + default: *682 '404': *6 x-github: githubCloudOnly: false @@ -100873,10 +102496,10 @@ paths: operationId: issues/update-label externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#update-a-label parameters: - - *461 - - *462 + - *465 + - *466 - name: name in: path required: true @@ -100939,10 +102562,10 @@ paths: operationId: issues/delete-label externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#delete-a-label parameters: - - *461 - - *462 + - *465 + - *466 - name: name in: path required: true @@ -100966,10 +102589,10 @@ paths: operationId: repos/list-languages externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-languages parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -101003,10 +102626,10 @@ paths: - repos externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '202': *37 '403': @@ -101032,10 +102655,10 @@ paths: - repos externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': description: Response @@ -101050,7 +102673,7 @@ paths: description: |- This method returns the contents of the repository's license file, if one is detected. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -101059,11 +102682,11 @@ paths: operationId: licenses/get-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *461 - - *462 - - *547 + - *465 + - *466 + - *551 responses: '200': description: Response @@ -101208,10 +102831,10 @@ paths: operationId: repos/merge-upstream externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -101274,10 +102897,10 @@ paths: operationId: repos/merge externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch + url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#merge-a-branch parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -101311,9 +102934,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *575 + schema: *579 examples: - default: *679 + default: *683 '204': description: Response when already merged '404': @@ -101336,10 +102959,10 @@ paths: operationId: issues/list-milestones externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#list-milestones parameters: - - *461 - - *462 + - *465 + - *466 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -101380,7 +103003,7 @@ paths: application/json: schema: type: array - items: *410 + items: *414 examples: default: value: @@ -101434,10 +103057,10 @@ paths: operationId: issues/create-milestone externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#create-a-milestone parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -101477,9 +103100,9 @@ paths: description: Response content: application/json: - schema: *410 + schema: *414 examples: - default: &680 + default: &684 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -101536,11 +103159,11 @@ paths: operationId: issues/get-milestone externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#get-a-milestone parameters: - - *461 - - *462 - - &681 + - *465 + - *466 + - &685 name: milestone_number description: The number that identifies the milestone. in: path @@ -101552,9 +103175,9 @@ paths: description: Response content: application/json: - schema: *410 + schema: *414 examples: - default: *680 + default: *684 '404': *6 x-github: githubCloudOnly: false @@ -101569,11 +103192,11 @@ paths: operationId: issues/update-milestone externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#update-a-milestone parameters: - - *461 - - *462 - - *681 + - *465 + - *466 + - *685 requestBody: required: false content: @@ -101611,9 +103234,9 @@ paths: description: Response content: application/json: - schema: *410 + schema: *414 examples: - default: *680 + default: *684 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101627,11 +103250,11 @@ paths: operationId: issues/delete-milestone externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#delete-a-milestone parameters: - - *461 - - *462 - - *681 + - *465 + - *466 + - *685 responses: '204': description: Response @@ -101650,11 +103273,11 @@ paths: operationId: issues/list-labels-for-milestone externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *461 - - *462 - - *681 + - *465 + - *466 + - *685 - *17 - *19 responses: @@ -101666,7 +103289,7 @@ paths: type: array items: *218 examples: - default: *660 + default: *664 headers: Link: *45 x-github: @@ -101683,14 +103306,14 @@ paths: operationId: activity/list-repo-notifications-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *461 - - *462 - - *682 - - *683 + - *465 + - *466 + - *686 + - *687 - *224 - - *684 + - *688 - *17 - *19 responses: @@ -101702,7 +103325,7 @@ paths: type: array items: *244 examples: - default: *685 + default: *689 headers: Link: *45 x-github: @@ -101717,17 +103340,17 @@ paths: you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications - for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) + for the authenticated user](https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. tags: - activity operationId: activity/mark-repo-notifications-as-read externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: false content: @@ -101783,16 +103406,16 @@ paths: operationId: repos/get-pages externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-a-apiname-pages-site parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response content: application/json: - schema: &686 + schema: &690 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -101936,7 +103559,7 @@ paths: - custom_404 - public examples: - default: &687 + default: &691 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -101975,10 +103598,10 @@ paths: operationId: repos/create-pages-site externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#create-a-apiname-pages-site parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -102033,9 +103656,9 @@ paths: description: Response content: application/json: - schema: *686 + schema: *690 examples: - default: *687 + default: *691 '422': *15 '409': *119 x-github: @@ -102056,10 +103679,10 @@ paths: operationId: repos/update-information-about-pages-site externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#update-information-about-a-apiname-pages-site + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -102073,7 +103696,7 @@ paths: - 'null' description: Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom - domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-cloud@latest//pages/configuring-a-custom-domain-for-your-github-pages-site)." + domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-cloud@latest/pages/configuring-a-custom-domain-for-your-github-pages-site)." https_enforced: type: boolean description: Specify whether HTTPS should be enforced for the repository. @@ -102165,10 +103788,10 @@ paths: operationId: repos/delete-pages-site externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': description: Response @@ -102192,10 +103815,10 @@ paths: operationId: repos/list-pages-builds externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#list-apiname-pages-builds parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 responses: @@ -102205,7 +103828,7 @@ paths: application/json: schema: type: array - items: &688 + items: &692 title: Page Build description: Page Build type: object @@ -102295,10 +103918,10 @@ paths: operationId: repos/request-pages-build externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#request-a-apiname-pages-build parameters: - - *461 - - *462 + - *465 + - *466 responses: '201': description: Response @@ -102343,18 +103966,18 @@ paths: operationId: repos/get-latest-pages-build externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-latest-pages-build parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response content: application/json: - schema: *688 + schema: *692 examples: - default: &689 + default: &693 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -102400,10 +104023,10 @@ paths: operationId: repos/get-pages-build externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-apiname-pages-build parameters: - - *461 - - *462 + - *465 + - *466 - name: build_id in: path required: true @@ -102414,9 +104037,9 @@ paths: description: Response content: application/json: - schema: *688 + schema: *692 examples: - default: *689 + default: *693 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102434,10 +104057,10 @@ paths: operationId: repos/create-pages-deployment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#create-a-github-pages-deployment parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -102543,11 +104166,11 @@ paths: operationId: repos/get-pages-deployment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-the-status-of-a-github-pages-deployment + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *461 - - *462 - - &690 + - *465 + - *466 + - &694 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -102603,11 +104226,11 @@ paths: operationId: repos/cancel-pages-deployment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *461 - - *462 - - *690 + - *465 + - *466 + - *694 responses: '204': *126 '404': *6 @@ -102632,10 +104255,10 @@ paths: operationId: repos/get-pages-health-check externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-dns-health-check-for-github-pages + url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -102922,16 +104545,16 @@ paths: summary: Check if private vulnerability reporting is enabled for a repository description: Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating - the security settings of a repository](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". + the security settings of a repository](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". tags: - repos operationId: repos/check-private-vulnerability-reporting externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Private vulnerability reporting status @@ -102960,16 +104583,16 @@ paths: summary: Enable private vulnerability reporting for a repository description: Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately - reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." + reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." tags: - repos operationId: repos/enable-private-vulnerability-reporting externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': *126 '422': *14 @@ -102982,16 +104605,16 @@ paths: summary: Disable private vulnerability reporting for a repository description: Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, - see "[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". + see "[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". tags: - repos operationId: repos/disable-private-vulnerability-reporting externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': *126 '422': *14 @@ -103011,10 +104634,10 @@ paths: operationId: repos/custom-properties-for-repos-get-repository-values externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#get-all-custom-property-values-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -103024,7 +104647,7 @@ paths: type: array items: *152 examples: - default: *691 + default: *695 '403': *27 '404': *6 x-github: @@ -103044,10 +104667,10 @@ paths: operationId: repos/custom-properties-for-repos-create-or-update-repository-values externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -103063,7 +104686,7 @@ paths: required: - properties examples: - default: *692 + default: *696 responses: '204': description: No Content when custom property values are successfully created @@ -103085,10 +104708,10 @@ paths: Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise - Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -103099,10 +104722,10 @@ paths: operationId: pulls/list externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests parameters: - - *461 - - *462 + - *465 + - *466 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -103162,9 +104785,9 @@ paths: application/json: schema: type: array - items: *579 + items: *583 examples: - default: *693 + default: *697 headers: Link: *45 '304': *35 @@ -103177,13 +104800,13 @@ paths: post: summary: Create a pull request description: |- - Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -103194,10 +104817,10 @@ paths: operationId: pulls/create externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#create-a-pull-request parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -103233,12 +104856,12 @@ paths: description: The contents of the pull request. maintainer_can_modify: type: boolean - description: Indicates whether [maintainers can modify](https://docs.github.com/enterprise-cloud@latest//articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) + description: Indicates whether [maintainers can modify](https://docs.github.com/enterprise-cloud@latest/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. draft: type: boolean description: Indicates whether the pull request is a draft. See - "[Draft Pull Requests](https://docs.github.com/enterprise-cloud@latest//articles/about-pull-requests#draft-pull-requests)" + "[Draft Pull Requests](https://docs.github.com/enterprise-cloud@latest/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. issue: type: integer @@ -103264,7 +104887,7 @@ paths: description: Response content: application/json: - schema: &697 + schema: &701 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -103393,7 +105016,7 @@ paths: milestone: anyOf: - type: 'null' - - *410 + - *414 active_lock_reason: type: - string @@ -103442,7 +105065,7 @@ paths: items: *4 requested_teams: type: array - items: *389 + items: *393 head: type: object properties: @@ -103480,14 +105103,14 @@ paths: _links: type: object properties: - comments: *411 - commits: *411 - statuses: *411 - html: *411 - issue: *411 - review_comments: *411 - review_comment: *411 - self: *411 + comments: *415 + commits: *415 + statuses: *415 + html: *415 + issue: *415 + review_comments: *415 + review_comment: *415 + self: *415 required: - comments - commits @@ -103498,7 +105121,7 @@ paths: - review_comment - self author_association: *216 - auto_merge: *694 + auto_merge: *698 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -103600,7 +105223,7 @@ paths: - merged_by - review_comments examples: - default: &698 + default: &702 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -104114,7 +105737,7 @@ paths: Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -104125,10 +105748,10 @@ paths: operationId: pulls/list-review-comments-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *461 - - *462 + - *465 + - *466 - name: sort in: query required: false @@ -104157,9 +105780,9 @@ paths: application/json: schema: type: array - items: *695 + items: *699 examples: - default: &700 + default: &704 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -104223,7 +105846,7 @@ paths: description: |- Provides details for a specified review comment. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -104234,19 +105857,19 @@ paths: operationId: pulls/get-review-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *461 - - *462 + - *465 + - *466 - *233 responses: '200': description: Response content: application/json: - schema: *695 + schema: *699 examples: - default: &696 + default: &700 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -104308,7 +105931,7 @@ paths: description: |- Edits the content of a specified review comment. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -104319,10 +105942,10 @@ paths: operationId: pulls/update-review-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#update-a-review-comment-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *461 - - *462 + - *465 + - *466 - *233 requestBody: required: true @@ -104345,9 +105968,9 @@ paths: description: Response content: application/json: - schema: *695 + schema: *699 examples: - default: *696 + default: *700 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104361,10 +105984,10 @@ paths: operationId: pulls/delete-review-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#delete-a-review-comment-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *461 - - *462 + - *465 + - *466 - *233 responses: '204': @@ -104378,19 +106001,19 @@ paths: "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": get: summary: List reactions for a pull request review comment - description: List the reactions to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). + description: List the reactions to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request). tags: - reactions operationId: reactions/list-for-pull-request-review-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *461 - - *462 + - *465 + - *466 - *233 - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). + description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. in: query required: false @@ -104414,9 +106037,9 @@ paths: application/json: schema: type: array - items: *573 + items: *577 examples: - default: *651 + default: *655 headers: Link: *45 '404': *6 @@ -104427,7 +106050,7 @@ paths: subcategory: reactions post: summary: Create reaction for a pull request review comment - description: Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). + description: Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. tags: @@ -104435,10 +106058,10 @@ paths: operationId: reactions/create-for-pull-request-review-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *461 - - *462 + - *465 + - *466 - *233 requestBody: required: true @@ -104449,7 +106072,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) + description: The [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions) to add to the pull request review comment. enum: - "+1" @@ -104471,16 +106094,16 @@ paths: description: Reaction exists content: application/json: - schema: *573 + schema: *577 examples: - default: *574 + default: *578 '201': description: Reaction created content: application/json: - schema: *573 + schema: *577 examples: - default: *574 + default: *578 '422': *15 x-github: githubCloudOnly: false @@ -104494,18 +106117,18 @@ paths: > [!NOTE] > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` - Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). + Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request). tags: - reactions operationId: reactions/delete-for-pull-request-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *461 - - *462 + - *465 + - *466 - *233 - - *652 + - *656 responses: '204': description: Response @@ -104518,23 +106141,23 @@ paths: get: summary: Get a pull request description: |- - Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists details of a pull request by providing its number. - When you get, [create](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + When you get, [create](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: - * If merged as a [merge commit](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * If merged via a [squash](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * If [rebased](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. + * If merged as a [merge commit](https://docs.github.com/enterprise-cloud@latest/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. + * If merged via a [squash](https://docs.github.com/enterprise-cloud@latest/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. + * If [rebased](https://docs.github.com/enterprise-cloud@latest/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. - Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. + Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -104546,11 +106169,11 @@ paths: operationId: pulls/get externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#get-a-pull-request parameters: - - *461 - - *462 - - &699 + - *465 + - *466 + - &703 name: pull_number description: The number that identifies the pull request. in: path @@ -104559,13 +106182,13 @@ paths: type: integer responses: '200': - description: Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) + description: Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. content: application/json: - schema: *697 + schema: *701 examples: - default: *698 + default: *702 '304': *35 '404': *6 '406': @@ -104583,11 +106206,11 @@ paths: patch: summary: Update a pull request description: |- - Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -104598,11 +106221,11 @@ paths: operationId: pulls/update externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request parameters: - - *461 - - *462 - - *699 + - *465 + - *466 + - *703 requestBody: required: false content: @@ -104630,7 +106253,7 @@ paths: another repository. maintainer_can_modify: type: boolean - description: Indicates whether [maintainers can modify](https://docs.github.com/enterprise-cloud@latest//articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) + description: Indicates whether [maintainers can modify](https://docs.github.com/enterprise-cloud@latest/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. examples: default: @@ -104644,9 +106267,9 @@ paths: description: Response content: application/json: - schema: *697 + schema: *701 examples: - default: *698 + default: *702 '422': *15 '403': *27 x-github: @@ -104666,11 +106289,11 @@ paths: operationId: pulls/archive externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#archive-a-pull-request parameters: - - *461 - - *462 - - *699 + - *465 + - *466 + - *703 responses: '204': description: Response @@ -104693,11 +106316,11 @@ paths: operationId: pulls/unarchive externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#unarchive-a-pull-request parameters: - - *461 - - *462 - - *699 + - *465 + - *466 + - *703 responses: '204': description: Response @@ -104721,11 +106344,11 @@ paths: operationId: codespaces/create-with-pr-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *461 - - *462 - - *699 + - *465 + - *466 + - *703 requestBody: required: true content: @@ -104786,17 +106409,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *381 + schema: *385 examples: - default: *564 + default: *568 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *381 + schema: *385 examples: - default: *564 + default: *568 '401': *23 '403': *27 '404': *6 @@ -104813,7 +106436,7 @@ paths: Lists all review comments for a specified pull request. By default, review comments are in ascending order by ID. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -104824,11 +106447,11 @@ paths: operationId: pulls/list-review-comments externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *461 - - *462 - - *699 + - *465 + - *466 + - *703 - *241 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -104849,9 +106472,9 @@ paths: application/json: schema: type: array - items: *695 + items: *699 examples: - default: *700 + default: *704 headers: Link: *45 x-github: @@ -104862,16 +106485,16 @@ paths: post: summary: Create a review comment for a pull request description: |- - Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment)." + Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#create-an-issue-comment)." If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -104882,11 +106505,11 @@ paths: operationId: pulls/create-review-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-review-comment-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *461 - - *462 - - *699 + - *465 + - *466 + - *703 requestBody: required: true content: @@ -104927,7 +106550,7 @@ paths: that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. - For more information, see "[Diff view options](https://docs.github.com/enterprise-cloud@latest//articles/about-comparing-branches-in-pull-requests#diff-view-options)" + For more information, see "[Diff view options](https://docs.github.com/enterprise-cloud@latest/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. enum: - LEFT @@ -104943,7 +106566,7 @@ paths: description: '**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn - more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" + more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation.' start_side: type: string @@ -104951,7 +106574,7 @@ paths: `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull - request](https://docs.github.com/enterprise-cloud@latest//articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" + request](https://docs.github.com/enterprise-cloud@latest/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context.' enum: @@ -104992,7 +106615,7 @@ paths: description: Response content: application/json: - schema: *695 + schema: *699 examples: example-for-a-multi-line-comment: value: @@ -105064,10 +106687,10 @@ paths: description: |- Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -105078,11 +106701,11 @@ paths: operationId: pulls/create-reply-for-review-comment externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *461 - - *462 - - *699 + - *465 + - *466 + - *703 - *233 requestBody: required: true @@ -105105,7 +106728,7 @@ paths: description: Response content: application/json: - schema: *695 + schema: *699 examples: default: value: @@ -105175,10 +106798,10 @@ paths: summary: List commits on a pull request description: |- Lists a maximum of 250 commits for a pull request. To receive a complete - commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits) + commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-commits) endpoint. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -105189,11 +106812,11 @@ paths: operationId: pulls/list-commits externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *461 - - *462 - - *699 + - *465 + - *466 + - *703 - *17 - *19 responses: @@ -105203,9 +106826,9 @@ paths: application/json: schema: type: array - items: *575 + items: *579 examples: - default: *701 + default: *705 headers: Link: *45 x-github: @@ -105222,7 +106845,7 @@ paths: > [!NOTE] > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -105233,11 +106856,11 @@ paths: operationId: pulls/list-files externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests-files parameters: - - *461 - - *462 - - *699 + - *465 + - *466 + - *703 - *17 - *19 responses: @@ -105247,7 +106870,7 @@ paths: application/json: schema: type: array - items: *586 + items: *590 examples: default: value: @@ -105283,11 +106906,11 @@ paths: operationId: pulls/check-if-merged externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#check-if-a-pull-request-has-been-merged + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *461 - - *462 - - *699 + - *465 + - *466 + - *703 responses: '204': description: Response if pull request has been merged @@ -105302,17 +106925,17 @@ paths: summary: Merge a pull request description: |- Merges a pull request into the base branch. - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." tags: - pulls operationId: pulls/merge externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#merge-a-pull-request parameters: - - *461 - - *462 - - *699 + - *465 + - *466 + - *703 requestBody: required: false content: @@ -105415,18 +107038,18 @@ paths: description: Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews - for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request) + for a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. tags: - pulls operationId: pulls/list-requested-reviewers externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *461 - - *462 - - *699 + - *465 + - *466 + - *703 responses: '200': description: Response @@ -105493,17 +107116,17 @@ paths: summary: Request reviewers for a pull request description: |- Requests reviews for a pull request from a given set of users and/or teams. - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." tags: - pulls operationId: pulls/request-reviewers externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *461 - - *462 - - *699 + - *465 + - *466 + - *703 requestBody: required: false content: @@ -105540,7 +107163,7 @@ paths: description: Response content: application/json: - schema: *579 + schema: *583 examples: default: value: @@ -106074,11 +107697,11 @@ paths: operationId: pulls/remove-requested-reviewers externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *461 - - *462 - - *699 + - *465 + - *466 + - *703 requestBody: required: true content: @@ -106112,7 +107735,7 @@ paths: description: Response content: application/json: - schema: *579 + schema: *583 examples: default: value: @@ -106604,7 +108227,7 @@ paths: description: |- Lists all reviews for a specified pull request. The list of reviews returns in chronological order. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -106615,11 +108238,11 @@ paths: operationId: pulls/list-reviews externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *461 - - *462 - - *699 + - *465 + - *466 + - *703 - *17 - *19 responses: @@ -106629,7 +108252,7 @@ paths: application/json: schema: type: array - items: &702 + items: &706 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -106763,16 +108386,16 @@ paths: description: |- Creates a review on a specified pull request. - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." - Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request)." + Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#submit-a-review-for-a-pull-request)." > [!NOTE] - > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) endpoint. + > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#get-a-pull-request) endpoint. The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -106783,11 +108406,11 @@ paths: operationId: pulls/create-review externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *461 - - *462 - - *699 + - *465 + - *466 + - *703 requestBody: required: false content: @@ -106811,7 +108434,7 @@ paths: description: 'The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, - which means you will need to [submit the pull request review](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request) + which means you will need to [submit the pull request review](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.' enum: - APPROVE @@ -106877,9 +108500,9 @@ paths: description: Response content: application/json: - schema: *702 + schema: *706 examples: - default: &704 + default: &708 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -106929,7 +108552,7 @@ paths: description: |- Retrieves a pull request review by its ID. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -106940,12 +108563,12 @@ paths: operationId: pulls/get-review externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *461 - - *462 - - *699 - - &703 + - *465 + - *466 + - *703 + - &707 name: review_id description: The unique identifier of the review. in: path @@ -106957,9 +108580,9 @@ paths: description: Response content: application/json: - schema: *702 + schema: *706 examples: - default: &705 + default: &709 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -107005,7 +108628,7 @@ paths: description: |- Updates the contents of a specified review summary comment. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -107016,12 +108639,12 @@ paths: operationId: pulls/update-review externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *461 - - *462 - - *699 + - *465 + - *466 - *703 + - *707 requestBody: required: true content: @@ -107044,7 +108667,7 @@ paths: description: Response content: application/json: - schema: *702 + schema: *706 examples: default: value: @@ -107093,7 +108716,7 @@ paths: description: |- Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -107104,20 +108727,20 @@ paths: operationId: pulls/delete-pending-review externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#delete-a-pending-review-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *461 - - *462 - - *699 + - *465 + - *466 - *703 + - *707 responses: '200': description: Response content: application/json: - schema: *702 + schema: *706 examples: - default: *704 + default: *708 '422': *7 '404': *6 x-github: @@ -107131,7 +108754,7 @@ paths: description: |- Lists comments for a specific pull request review. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -107142,12 +108765,12 @@ paths: operationId: pulls/list-comments-for-review externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *461 - - *462 - - *699 + - *465 + - *466 - *703 + - *707 - *17 - *19 responses: @@ -107245,9 +108868,9 @@ paths: _links: type: object properties: - self: *411 - html: *411 - pull_request: *411 + self: *415 + html: *415 + pull_request: *415 required: - self - html @@ -107390,9 +109013,9 @@ paths: Dismisses a specified review on a pull request. > [!NOTE] - > To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. + > To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -107403,12 +109026,12 @@ paths: operationId: pulls/dismiss-review externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *461 - - *462 - - *699 + - *465 + - *466 - *703 + - *707 requestBody: required: true content: @@ -107437,7 +109060,7 @@ paths: description: Response content: application/json: - schema: *702 + schema: *706 examples: default: value: @@ -107485,9 +109108,9 @@ paths: post: summary: Submit a review for a pull request description: |- - Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request)." + Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#create-a-review-for-a-pull-request)." - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -107498,12 +109121,12 @@ paths: operationId: pulls/submit-review externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *461 - - *462 - - *699 + - *465 + - *466 - *703 + - *707 requestBody: required: true content: @@ -107538,9 +109161,9 @@ paths: description: Response content: application/json: - schema: *702 + schema: *706 examples: - default: *705 + default: *709 '404': *6 '422': *7 '403': *27 @@ -107560,11 +109183,11 @@ paths: operationId: pulls/update-branch externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch + url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *461 - - *462 - - *699 + - *465 + - *466 + - *703 requestBody: required: false content: @@ -107580,7 +109203,7 @@ paths: This is the most recent commit on the pull request''s branch. If the expected SHA does not match the pull request''s HEAD, you will receive a `422 Unprocessable Entity` status. You can use - the "[List commits](https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits)" + the "[List commits](https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request''s current HEAD ref.' examples: @@ -107617,7 +109240,7 @@ paths: description: |- Gets the preferred README for a repository. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -107626,10 +109249,10 @@ paths: operationId: repos/get-readme externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-a-repository-readme parameters: - - *461 - - *462 + - *465 + - *466 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -107642,9 +109265,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *710 examples: - default: &707 + default: &711 value: type: file encoding: base64 @@ -107675,7 +109298,7 @@ paths: description: |- Gets the README from a repository directory. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -107684,10 +109307,10 @@ paths: operationId: repos/get-readme-in-directory externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme-for-a-directory + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *461 - - *462 + - *465 + - *466 - name: dir description: The alternate path to look for a README file in: path @@ -107707,9 +109330,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *710 examples: - default: *707 + default: *711 '404': *6 '422': *15 x-github: @@ -107721,7 +109344,7 @@ paths: get: summary: List releases description: |- - This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags). + This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-tags). Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. tags: @@ -107729,10 +109352,10 @@ paths: operationId: repos/list-releases externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#list-releases parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 responses: @@ -107742,7 +109365,7 @@ paths: application/json: schema: type: array - items: *708 + items: *712 examples: default: value: @@ -107828,16 +109451,16 @@ paths: description: |- Users with push access to the repository can create a release. - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." tags: - repos operationId: repos/create-release externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#create-a-release parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -107875,7 +109498,7 @@ paths: description: If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see - "[Managing categories for discussions in your repository](https://docs.github.com/enterprise-cloud@latest//discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." + "[Managing categories for discussions in your repository](https://docs.github.com/enterprise-cloud@latest/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." generate_release_notes: type: boolean description: Whether to automatically generate the name and body @@ -107913,9 +109536,9 @@ paths: description: Response content: application/json: - schema: *708 + schema: *712 examples: - default: &712 + default: &716 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -108010,7 +109633,7 @@ paths: description: "To download the asset's binary content:\n\n- If within a browser, fetch the location specified in the `browser_download_url` key provided in the response.\n- Alternatively, set the `Accept` header of the request to - \n [`application/octet-stream`](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + \n [`application/octet-stream`](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). \n The API will either redirect the client to the location, or stream it directly if possible.\n API clients should handle both a `200` or `302` response." tags: @@ -108018,11 +109641,11 @@ paths: operationId: repos/get-release-asset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#get-a-release-asset parameters: - - *461 - - *462 - - &710 + - *465 + - *466 + - &714 name: asset_id description: The unique identifier of the asset. in: path @@ -108034,9 +109657,9 @@ paths: description: Response content: application/json: - schema: *709 + schema: *713 examples: - default: &711 + default: &715 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -108071,7 +109694,7 @@ paths: type: User site_admin: false '404': *6 - '302': *590 + '302': *594 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108085,11 +109708,11 @@ paths: operationId: repos/update-release-asset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#update-a-release-asset parameters: - - *461 - - *462 - - *710 + - *465 + - *466 + - *714 requestBody: required: false content: @@ -108118,9 +109741,9 @@ paths: description: Response content: application/json: - schema: *709 + schema: *713 examples: - default: *711 + default: *715 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108134,11 +109757,11 @@ paths: operationId: repos/delete-release-asset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#delete-a-release-asset parameters: - - *461 - - *462 - - *710 + - *465 + - *466 + - *714 responses: '204': description: Response @@ -108151,7 +109774,7 @@ paths: "/repos/{owner}/{repo}/releases/generate-notes": post: summary: Generate release notes content for a release - description: Generate a name and body describing a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). + description: Generate a name and body describing a [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when @@ -108161,10 +109784,10 @@ paths: operationId: repos/generate-release-notes externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#generate-release-notes-content-for-a-release + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -108248,18 +109871,18 @@ paths: operationId: repos/get-latest-release externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-the-latest-release parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response content: application/json: - schema: *708 + schema: *712 examples: - default: *712 + default: *716 '404': *6 x-github: githubCloudOnly: false @@ -108275,10 +109898,10 @@ paths: operationId: repos/get-release-by-tag externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release-by-tag-name parameters: - - *461 - - *462 + - *465 + - *466 - name: tag description: tag parameter in: path @@ -108291,9 +109914,9 @@ paths: description: Response content: application/json: - schema: *708 + schema: *712 examples: - default: *712 + default: *716 '404': *6 x-github: githubCloudOnly: false @@ -108307,17 +109930,17 @@ paths: Gets a public release with the specified release ID. > [!NOTE] - > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." tags: - repos operationId: repos/get-release externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release parameters: - - *461 - - *462 - - &713 + - *465 + - *466 + - &717 name: release_id description: The unique identifier of the release. in: path @@ -108328,12 +109951,12 @@ paths: '200': description: '**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. - For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' + For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *708 + schema: *712 examples: - default: *712 + default: *716 '401': description: Unauthorized x-github: @@ -108349,11 +109972,11 @@ paths: operationId: repos/update-release externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#update-a-release parameters: - - *461 - - *462 - - *713 + - *465 + - *466 + - *717 requestBody: required: false content: @@ -108402,7 +110025,7 @@ paths: is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, - see "[Managing categories for discussions in your repository](https://docs.github.com/enterprise-cloud@latest//discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." + see "[Managing categories for discussions in your repository](https://docs.github.com/enterprise-cloud@latest/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." examples: default: value: @@ -108417,9 +110040,9 @@ paths: description: Response content: application/json: - schema: *708 + schema: *712 examples: - default: *712 + default: *716 '404': description: Not Found if the discussion category name is invalid content: @@ -108438,11 +110061,11 @@ paths: operationId: repos/delete-release externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#delete-a-release parameters: - - *461 - - *462 - - *713 + - *465 + - *466 + - *717 responses: '204': description: Response @@ -108461,11 +110084,11 @@ paths: operationId: repos/list-release-assets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#list-release-assets parameters: - - *461 - - *462 - - *713 + - *465 + - *466 + - *717 - *17 - *19 responses: @@ -108475,7 +110098,7 @@ paths: application/json: schema: type: array - items: *709 + items: *713 examples: default: value: @@ -108520,10 +110143,10 @@ paths: subcategory: assets post: summary: Upload a release asset - description: "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) + description: "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe - response of the [Create a release endpoint](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release) + response of the [Create a release endpoint](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header @@ -108538,11 +110161,11 @@ paths: an empty asset with a state of `starter`. It can be safely deleted.\n\n**Notes:**\n* \ GitHub Enterprise Cloud renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List - release assets](https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets)\"\nendpoint + release assets](https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#list-release-assets)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* \ To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` - endpoint](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release). + endpoint](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-the-latest-release). \n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset." @@ -108551,15 +110174,15 @@ paths: operationId: repos/upload-release-asset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#upload-a-release-asset + url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#upload-a-release-asset servers: - url: https://uploads.github.com description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *461 - - *462 - - *713 + - *465 + - *466 + - *717 - name: name in: query required: true @@ -108585,7 +110208,7 @@ paths: description: Response for successful upload content: application/json: - schema: *709 + schema: *713 examples: response-for-successful-upload: value: @@ -108632,19 +110255,19 @@ paths: "/repos/{owner}/{repo}/releases/{release_id}/reactions": get: summary: List reactions for a release - description: List the reactions to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). + description: List the reactions to a [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release). tags: - reactions operationId: reactions/list-for-release externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *461 - - *462 - - *713 + - *465 + - *466 + - *717 - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). + description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. in: query required: false @@ -108666,9 +110289,9 @@ paths: application/json: schema: type: array - items: *573 + items: *577 examples: - default: *651 + default: *655 headers: Link: *45 '404': *6 @@ -108679,7 +110302,7 @@ paths: subcategory: reactions post: summary: Create reaction for a release - description: 'Create a reaction to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). + description: 'Create a reaction to a [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.' tags: @@ -108687,11 +110310,11 @@ paths: operationId: reactions/create-for-release externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *461 - - *462 - - *713 + - *465 + - *466 + - *717 requestBody: required: true content: @@ -108701,7 +110324,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) + description: The [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions) to add to the release. enum: - "+1" @@ -108721,16 +110344,16 @@ paths: description: Reaction exists content: application/json: - schema: *573 + schema: *577 examples: - default: *574 + default: *578 '201': description: Reaction created content: application/json: - schema: *573 + schema: *577 examples: - default: *574 + default: *578 '422': *15 x-github: githubCloudOnly: false @@ -108744,18 +110367,18 @@ paths: > [!NOTE] > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. - Delete a reaction to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). + Delete a reaction to a [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release). tags: - reactions operationId: reactions/delete-for-release externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction + url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-release-reaction parameters: - - *461 - - *462 - - *713 - - *652 + - *465 + - *466 + - *717 + - *656 responses: '204': description: Response @@ -108777,11 +110400,11 @@ paths: operationId: repos/get-branch-rules externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-rules-for-a-branch parameters: - - *461 - - *462 - - *514 + - *465 + - *466 + - *518 - *17 - *19 responses: @@ -108798,7 +110421,7 @@ paths: oneOf: - allOf: - *166 - - &714 + - &718 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -108819,67 +110442,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *167 - - *714 + - *718 - allOf: - *168 - - *714 + - *718 - allOf: - *169 - - *714 + - *718 - allOf: - - *715 - - *714 + - *719 + - *718 - allOf: - *170 - - *714 + - *718 - allOf: - *171 - - *714 + - *718 - allOf: - *172 - - *714 + - *718 - allOf: - *173 - - *714 + - *718 - allOf: - *174 - - *714 + - *718 - allOf: - *175 - - *714 + - *718 - allOf: - *176 - - *714 + - *718 - allOf: - *177 - - *714 + - *718 - allOf: - *178 - - *714 + - *718 - allOf: - *179 - - *714 + - *718 - allOf: - *180 - - *714 + - *718 - allOf: - *181 - - *714 + - *718 - allOf: - *182 - - *714 + - *718 - allOf: - *183 - - *714 + - *718 - allOf: - *184 - - *714 + - *718 - allOf: - *185 - - *714 + - *718 - allOf: - *186 - - *714 + - *718 examples: default: value: @@ -108911,15 +110534,15 @@ paths: operationId: repos/get-repo-rulesets externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-all-repository-rulesets + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-all-repository-rulesets x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: rules parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 - name: includes_parents @@ -108930,7 +110553,7 @@ paths: schema: type: boolean default: true - - *716 + - *720 responses: '200': description: Response @@ -108978,15 +110601,15 @@ paths: operationId: repos/create-repo-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#create-a-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#create-a-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: rules parameters: - - *461 - - *462 + - *465 + - *466 requestBody: description: Request body required: true @@ -109015,7 +110638,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *717 + items: *721 required: - name - enforcement @@ -109048,7 +110671,7 @@ paths: application/json: schema: *187 examples: - default: &726 + default: &730 value: id: 42 name: super cool ruleset @@ -109088,20 +110711,20 @@ paths: summary: List repository rule suites description: |- Lists suites of rule evaluations at the repository level. - For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." tags: - repos operationId: repos/get-repo-rule-suites externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *461 - - *462 - - *718 + - *465 + - *466 + - *722 - *105 - - *719 - - *720 + - *723 + - *724 - *17 - *19 responses: @@ -109109,9 +110732,9 @@ paths: description: Response content: application/json: - schema: *721 + schema: *725 examples: - default: *722 + default: *726 '404': *6 '500': *38 x-github: @@ -109124,25 +110747,25 @@ paths: summary: Get a repository rule suite description: |- Gets information about a suite of rule evaluations from within a repository. - For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." tags: - repos operationId: repos/get-repo-rule-suite externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *461 - - *462 - - *723 + - *465 + - *466 + - *727 responses: '200': description: Response content: application/json: - schema: *724 + schema: *728 examples: - default: *725 + default: *729 '404': *6 '500': *38 x-github: @@ -109163,15 +110786,15 @@ paths: operationId: repos/get-repo-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-a-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-a-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: rules parameters: - - *461 - - *462 + - *465 + - *466 - name: ruleset_id description: The ID of the ruleset. in: path @@ -109193,7 +110816,7 @@ paths: application/json: schema: *187 examples: - default: *726 + default: *730 '404': *6 '500': *38 put: @@ -109204,15 +110827,15 @@ paths: operationId: repos/update-repo-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#update-a-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#update-a-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: rules parameters: - - *461 - - *462 + - *465 + - *466 - name: ruleset_id description: The ID of the ruleset. in: path @@ -109246,7 +110869,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *717 + items: *721 examples: default: value: @@ -109276,7 +110899,7 @@ paths: application/json: schema: *187 examples: - default: *726 + default: *730 '404': *6 '422': *15 '500': *38 @@ -109288,15 +110911,15 @@ paths: operationId: repos/delete-repo-ruleset externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#delete-a-repository-ruleset + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#delete-a-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: rules parameters: - - *461 - - *462 + - *465 + - *466 - name: ruleset_id description: The ID of the ruleset. in: path @@ -109317,10 +110940,10 @@ paths: operationId: repos/get-repo-ruleset-history externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-repository-ruleset-history parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 - name: ruleset_id @@ -109338,7 +110961,7 @@ paths: type: array items: *191 examples: - default: *427 + default: *431 '404': *6 '500': *38 x-github: @@ -109355,10 +110978,10 @@ paths: operationId: repos/get-repo-ruleset-version externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-repository-ruleset-version parameters: - - *461 - - *462 + - *465 + - *466 - name: ruleset_id description: The ID of the ruleset. in: path @@ -109376,7 +110999,7 @@ paths: description: Response content: application/json: - schema: *428 + schema: *432 examples: default: value: @@ -109429,27 +111052,27 @@ paths: operationId: secret-scanning/list-alerts-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *461 - - *462 - - *429 - - *430 - - *431 - - *432 + - *465 + - *466 - *433 - *434 - *435 - *436 - - *110 - - *19 - - *17 - - *727 - - *728 - *437 - *438 - *439 - *440 + - *110 + - *19 + - *17 + - *731 + - *732 + - *441 + - *442 + - *443 + - *444 responses: '200': description: Response @@ -109457,7 +111080,7 @@ paths: application/json: schema: type: array - items: &732 + items: &736 type: object properties: number: *127 @@ -109473,8 +111096,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *729 - resolution: *730 + state: *733 + resolution: *734 resolved_at: type: - string @@ -109498,7 +111121,7 @@ paths: type: string description: |- User-friendly name for the detected secret, matching the `secret_type`. - For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." provider: type: - string @@ -109580,7 +111203,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *731 + - *735 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -109737,18 +111360,18 @@ paths: operationId: secret-scanning/get-alert externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *461 - - *462 - - *541 - - *440 + - *465 + - *466 + - *545 + - *444 responses: '200': description: Response content: application/json: - schema: *732 + schema: *736 examples: default: value: @@ -109800,11 +111423,11 @@ paths: - secret-scanning externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *461 - - *462 - - *541 + - *465 + - *466 + - *545 requestBody: required: true content: @@ -109812,8 +111435,8 @@ paths: schema: type: object properties: - state: *729 - resolution: *730 + state: *733 + resolution: *734 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -109826,6 +111449,16 @@ paths: type: - string - 'null' + validity: + type: + - string + - 'null' + enum: + - active + - inactive + - + description: Sets the validity of the secret scanning alert. Can + be `active`, `inactive`, or `null` to clear the override. anyOf: - required: - state @@ -109851,7 +111484,7 @@ paths: description: Response content: application/json: - schema: *732 + schema: *736 examples: default: value: @@ -109923,7 +111556,8 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment, - or assignee does not have write access to the repository + assignee does not have write access to the repository, or the requested + validity change could not be applied to this alert '503': *192 x-github: enabledForGitHubApps: true @@ -109944,11 +111578,11 @@ paths: operationId: secret-scanning/list-locations-for-alert externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *461 - - *462 - - *541 + - *465 + - *466 + - *545 - *19 - *17 responses: @@ -109959,7 +111593,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &910 + items: &915 type: object properties: type: @@ -109986,10 +111620,6 @@ paths: - commit details: oneOf: - - *733 - - *734 - - *735 - - *736 - *737 - *738 - *739 @@ -109999,6 +111629,10 @@ paths: - *743 - *744 - *745 + - *746 + - *747 + - *748 + - *749 examples: default: value: @@ -110082,10 +111716,10 @@ paths: - secret-scanning externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#create-a-push-protection-bypass + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -110093,14 +111727,14 @@ paths: schema: type: object properties: - reason: &747 + reason: &751 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *746 + placeholder_id: *750 required: - reason - placeholder_id @@ -110117,7 +111751,7 @@ paths: schema: type: object properties: - reason: *747 + reason: *751 expire_at: type: - string @@ -110154,7 +111788,7 @@ paths: Lists the latest default incremental and backfill scans by type for a repository. > [!NOTE] - > This endpoint requires [GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security). + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest/get-started/learning-about-github/about-github-advanced-security). OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: @@ -110162,10 +111796,10 @@ paths: operationId: secret-scanning/get-scan-history externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -110180,7 +111814,7 @@ paths: properties: incremental_scans: type: array - items: &748 + items: &752 description: Information on a single scan performed by secret scanning on the repository type: object @@ -110208,15 +111842,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *748 + items: *752 backfill_scans: type: array - items: *748 + items: *752 custom_pattern_backfill_scans: type: array items: allOf: - - *748 + - *752 - type: object properties: pattern_name: @@ -110229,7 +111863,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *748 + items: *752 examples: default: value: @@ -110292,10 +111926,10 @@ paths: operationId: security-advisories/list-repository-advisories externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories + url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *461 - - *462 + - *465 + - *466 - *110 - name: sort description: The property to sort the results by. @@ -110312,7 +111946,7 @@ paths: - *109 - name: per_page description: The number of advisories to return per page. For more information, - see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." + see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: @@ -110339,9 +111973,9 @@ paths: application/json: schema: type: array - items: *749 + items: *753 examples: - default: *750 + default: *754 '400': *14 '404': *6 x-github: @@ -110362,10 +111996,10 @@ paths: operationId: security-advisories/create-repository-advisory externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-repository-security-advisory + url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -110445,7 +112079,7 @@ paths: login: type: string description: The username of the user credited. - type: *445 + type: *449 required: - login - type @@ -110535,9 +112169,9 @@ paths: description: Response content: application/json: - schema: *749 + schema: *753 examples: - default: &752 + default: &756 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -110762,16 +112396,16 @@ paths: summary: Privately report a security vulnerability description: |- Report a security vulnerability to the maintainers of the repository. - See "[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting. + See "[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting. tags: - security-advisories operationId: security-advisories/create-private-vulnerability-report externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability + url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -110884,7 +112518,7 @@ paths: description: Response content: application/json: - schema: *749 + schema: *753 examples: default: value: @@ -111029,19 +112663,19 @@ paths: operationId: security-advisories/get-repository-advisory externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory + url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *461 - - *462 - - *751 + - *465 + - *466 + - *755 responses: '200': description: Response content: application/json: - schema: *749 + schema: *753 examples: - default: *752 + default: *756 '403': *27 '404': *6 x-github: @@ -111063,11 +112697,11 @@ paths: operationId: security-advisories/update-repository-advisory externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory + url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *461 - - *462 - - *751 + - *465 + - *466 + - *755 requestBody: required: true content: @@ -111147,7 +112781,7 @@ paths: login: type: string description: The username of the user credited. - type: *445 + type: *449 required: - login - type @@ -111238,10 +112872,10 @@ paths: description: Response content: application/json: - schema: *749 + schema: *753 examples: - default: *752 - add_credit: *752 + default: *756 + add_credit: *756 '403': *27 '404': *6 '422': @@ -111265,7 +112899,7 @@ paths: post: summary: Request a CVE for a repository security advisory description: |- - If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." + If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." You may request a CVE for public repositories, but cannot do so for private repositories. @@ -111277,11 +112911,11 @@ paths: operationId: security-advisories/create-repository-advisory-cve-request externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory + url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *461 - - *462 - - *751 + - *465 + - *466 + - *755 responses: '202': *37 '400': *14 @@ -111306,19 +112940,19 @@ paths: operationId: security-advisories/create-fork externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-temporary-private-fork + url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *461 - - *462 - - *751 + - *465 + - *466 + - *755 responses: '202': description: Response content: application/json: - schema: *466 + schema: *470 examples: - default: *468 + default: *472 '400': *14 '422': *15 '403': *27 @@ -111334,7 +112968,7 @@ paths: description: |- Lists the people that have starred the repository. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. tags: @@ -111342,10 +112976,10 @@ paths: operationId: activity/list-stargazers-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-stargazers parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 responses: @@ -111439,10 +113073,10 @@ paths: operationId: repos/get-code-frequency-stats externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity + url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -111451,7 +113085,7 @@ paths: application/json: schema: type: array - items: &753 + items: &757 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -111482,10 +113116,10 @@ paths: operationId: repos/get-commit-activity-stats externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-last-year-of-commit-activity + url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -111561,10 +113195,10 @@ paths: operationId: repos/get-contributors-stats externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity + url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -111656,10 +113290,10 @@ paths: operationId: repos/get-participation-stats externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count + url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -111811,10 +113445,10 @@ paths: operationId: repos/get-punch-card-stats externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-hourly-commit-count-for-each-day + url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -111824,7 +113458,7 @@ paths: application/json: schema: type: array - items: *753 + items: *757 examples: default: value: @@ -111855,10 +113489,10 @@ paths: operationId: repos/create-commit-status externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status + url: https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#create-a-commit-status parameters: - - *461 - - *462 + - *465 + - *466 - name: sha in: path required: true @@ -111914,7 +113548,7 @@ paths: description: Response content: application/json: - schema: *754 + schema: *758 examples: default: value: @@ -111966,10 +113600,10 @@ paths: operationId: activity/list-watchers-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#list-watchers parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 responses: @@ -111999,16 +113633,16 @@ paths: operationId: activity/get-repo-subscription externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#get-a-repository-subscription parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &755 + schema: &759 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -112072,17 +113706,17 @@ paths: description: If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's - subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription) + subscription](https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#delete-a-repository-subscription) completely. tags: - activity operationId: activity/set-repo-subscription externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#set-a-repository-subscription parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: false content: @@ -112108,7 +113742,7 @@ paths: description: Response content: application/json: - schema: *755 + schema: *759 examples: default: value: @@ -112127,16 +113761,16 @@ paths: summary: Delete a repository subscription description: This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, - [set the repository's subscription manually](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription). + [set the repository's subscription manually](https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#set-a-repository-subscription). tags: - activity operationId: activity/delete-repo-subscription externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#delete-a-repository-subscription parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': description: Response @@ -112154,10 +113788,10 @@ paths: operationId: repos/list-tags externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-tags parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 responses: @@ -112236,11 +113870,11 @@ paths: - repos externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *461 - - *462 + - *465 + - *466 - name: ref in: path required: true @@ -112274,10 +113908,10 @@ paths: operationId: repos/list-teams externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-teams parameters: - - *461 - - *462 + - *465 + - *466 - *17 - *19 responses: @@ -112289,7 +113923,7 @@ paths: type: array items: *307 examples: - default: *390 + default: *394 headers: Link: *45 '404': *6 @@ -112307,10 +113941,10 @@ paths: operationId: repos/get-all-topics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-all-repository-topics parameters: - - *461 - - *462 + - *465 + - *466 - *19 - *17 responses: @@ -112318,7 +113952,7 @@ paths: description: Response content: application/json: - schema: &756 + schema: &760 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -112330,7 +113964,7 @@ paths: required: - names examples: - default: &757 + default: &761 value: names: - octocat @@ -112351,10 +113985,10 @@ paths: operationId: repos/replace-all-topics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#replace-all-repository-topics parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -112385,9 +114019,9 @@ paths: description: Response content: application/json: - schema: *756 + schema: *760 examples: - default: *757 + default: *761 '404': *6 '422': *7 x-github: @@ -112406,11 +114040,11 @@ paths: operationId: repos/get-clones externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones + url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-repository-clones parameters: - - *461 - - *462 - - &758 + - *465 + - *466 + - &762 name: per description: The time frame to display results for. in: query @@ -112441,7 +114075,7 @@ paths: - 128 clones: type: array - items: &759 + items: &763 title: Traffic type: object properties: @@ -112526,10 +114160,10 @@ paths: operationId: repos/get-top-paths externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths + url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-top-referral-paths parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -112621,10 +114255,10 @@ paths: operationId: repos/get-top-referrers externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources + url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-top-referral-sources parameters: - - *461 - - *462 + - *465 + - *466 responses: '200': description: Response @@ -112685,11 +114319,11 @@ paths: operationId: repos/get-views externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views + url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-page-views parameters: - - *461 - - *462 - - *758 + - *465 + - *466 + - *762 responses: '200': description: Response @@ -112710,7 +114344,7 @@ paths: - 3782 views: type: array - items: *759 + items: *763 required: - uniques - count @@ -112779,16 +114413,16 @@ paths: transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, - see [about repository transfers](https://docs.github.com/enterprise-cloud@latest//articles/about-repository-transfers/). + see [about repository transfers](https://docs.github.com/enterprise-cloud@latest/articles/about-repository-transfers/). tags: - repos operationId: repos/transfer externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#transfer-a-repository parameters: - - *461 - - *462 + - *465 + - *466 requestBody: required: true content: @@ -113054,16 +114688,16 @@ paths: summary: Check if vulnerability alerts are enabled for a repository description: Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For - more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)". + more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest/articles/about-security-alerts-for-vulnerable-dependencies)". tags: - repos operationId: repos/check-vulnerability-alerts externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -113078,16 +114712,16 @@ paths: summary: Enable vulnerability alerts description: Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more - information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)". + information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest/articles/about-security-alerts-for-vulnerable-dependencies)". tags: - repos operationId: repos/enable-vulnerability-alerts externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-vulnerability-alerts parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': description: Response @@ -113101,16 +114735,16 @@ paths: description: |- Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, - see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)". + see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest/articles/about-security-alerts-for-vulnerable-dependencies)". tags: - repos operationId: repos/disable-vulnerability-alerts externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-vulnerability-alerts parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': description: Response @@ -113133,11 +114767,11 @@ paths: - repos externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *461 - - *462 + - *465 + - *466 - name: ref in: path required: true @@ -113161,7 +114795,7 @@ paths: post: summary: Create a repository using a template description: |- - Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. + Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. tags: @@ -113169,7 +114803,7 @@ paths: operationId: repos/create-using-template externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-using-a-template + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-using-a-template parameters: - name: template_owner description: The account owner of the template repository. The name is not @@ -113229,9 +114863,9 @@ paths: description: Response content: application/json: - schema: *466 + schema: *470 examples: - default: *468 + default: *472 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -113250,13 +114884,13 @@ paths: Note: - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. - - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. + - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. tags: - repos operationId: repos/list-public externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-public-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-public-repositories parameters: - name: since description: A repository ID. Only return repositories with an ID greater @@ -113367,7 +115001,7 @@ paths: - scim externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise parameters: - name: filter description: If specified, only results that match the specified filter will @@ -113382,7 +115016,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &767 + - &771 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -113392,7 +115026,7 @@ paths: type: string examples: - members - - &772 + - &776 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -113404,7 +115038,7 @@ paths: format: int32 examples: - 1 - - &773 + - &777 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -113448,7 +115082,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &762 + items: &766 allOf: - type: object required: @@ -113530,7 +115164,7 @@ paths: - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 - meta: &774 + meta: &778 type: object description: The metadata associated with the creation/updates to the user. @@ -113595,30 +115229,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &763 + '400': &767 description: Bad request content: application/json: - schema: *760 + schema: *764 application/scim+json: - schema: *760 - '401': *761 - '403': &764 + schema: *764 + '401': *765 + '403': &768 description: Permission denied - '429': &765 + '429': &769 description: Too many requests content: application/json: - schema: *760 + schema: *764 application/scim+json: - schema: *760 - '500': &766 + schema: *764 + '500': &770 description: Internal server error content: application/json: - schema: *760 + schema: *764 application/scim+json: - schema: *760 + schema: *764 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113635,14 +115269,14 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#provision-a-scim-enterprise-group + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#provision-a-scim-enterprise-group parameters: - *39 requestBody: required: true content: application/json: - schema: &770 + schema: &774 type: object required: - schemas @@ -113706,9 +115340,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *762 + schema: *766 examples: - group: &768 + group: &772 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -113727,13 +115361,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 - '400': *763 - '401': *761 - '403': *764 - '409': &771 + '400': *767 + '401': *765 + '403': *768 + '409': &775 description: Duplicate record detected - '429': *765 - '500': *766 + '429': *769 + '500': *770 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113748,9 +115382,9 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group parameters: - - &769 + - &773 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -113759,22 +115393,22 @@ paths: type: string examples: - 7fce0092-d52e-4f76-b727-3955bd72c939 - - *767 + - *771 - *39 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *762 + schema: *766 examples: - default: *768 - '400': *763 - '401': *761 - '403': *764 + default: *772 + '400': *767 + '401': *765 + '403': *768 '404': *6 - '429': *765 - '500': *766 + '429': *769 + '500': *770 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113791,15 +115425,15 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group parameters: - - *769 + - *773 - *39 requestBody: required: true content: application/json: - schema: *770 + schema: *774 examples: group: summary: Group @@ -113825,17 +115459,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *762 + schema: *766 examples: - group: *768 - groupWithMembers: *768 - '400': *763 - '401': *761 - '403': *764 + group: *772 + groupWithMembers: *772 + '400': *767 + '401': *765 + '403': *768 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *775 + '429': *769 + '500': *770 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113857,15 +115491,15 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group parameters: - - *769 + - *773 - *39 requestBody: required: true content: application/json: - schema: &781 + schema: &785 type: object required: - Operations @@ -113925,17 +115559,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *762 + schema: *766 examples: - updateGroup: *768 - addMembers: *768 - '400': *763 - '401': *761 - '403': *764 + updateGroup: *772 + addMembers: *772 + '400': *767 + '401': *765 + '403': *768 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *775 + '429': *769 + '500': *770 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113949,19 +115583,19 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise parameters: - - *769 + - *773 - *39 responses: '204': description: Group was deleted, no content - '400': *763 - '401': *761 - '403': *764 + '400': *767 + '401': *765 + '403': *768 '404': *6 - '429': *765 - '500': *766 + '429': *769 + '500': *770 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113979,7 +115613,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise parameters: - name: filter description: If specified, only results that match the specified filter will @@ -113995,8 +115629,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *772 - - *773 + - *776 + - *777 - *39 responses: '200': @@ -114030,7 +115664,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &776 + items: &780 allOf: - type: object required: @@ -114122,7 +115756,7 @@ paths: address. examples: - true - roles: &775 + roles: &779 type: array description: The roles assigned to the user. items: @@ -114181,7 +115815,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *774 + meta: *778 startIndex: type: integer description: A starting index for the returned page @@ -114220,11 +115854,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *763 - '401': *761 - '403': *764 - '429': *765 - '500': *766 + '400': *767 + '401': *765 + '403': *768 + '429': *769 + '500': *770 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -114241,14 +115875,14 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#provision-a-scim-enterprise-user + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#provision-a-scim-enterprise-user parameters: - *39 requestBody: required: true content: application/json: - schema: &779 + schema: &783 type: object required: - schemas @@ -114341,9 +115975,9 @@ paths: description: Whether this email address is the primary address. examples: - true - roles: *775 + roles: *779 examples: - user: &780 + user: &784 summary: User value: schemas: @@ -114390,9 +116024,9 @@ paths: description: User has been created content: application/scim+json: - schema: *776 + schema: *780 examples: - user: &777 + user: &781 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -114418,13 +116052,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 - enterpriseOwner: *777 - '400': *763 - '401': *761 - '403': *764 - '409': *771 - '429': *765 - '500': *766 + enterpriseOwner: *781 + '400': *767 + '401': *765 + '403': *768 + '409': *775 + '429': *769 + '500': *770 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -114439,9 +116073,9 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user parameters: - - &778 + - &782 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -114454,15 +116088,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *776 + schema: *780 examples: - default: *777 - '400': *763 - '401': *761 - '403': *764 + default: *781 + '400': *767 + '401': *765 + '403': *768 '404': *6 - '429': *765 - '500': *766 + '429': *769 + '500': *770 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -114511,32 +116145,32 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user parameters: - - *778 + - *782 - *39 requestBody: required: true content: application/json: - schema: *779 + schema: *783 examples: - user: *780 + user: *784 responses: '200': description: User was updated content: application/scim+json: - schema: *776 + schema: *780 examples: - user: *777 - '400': *763 - '401': *761 - '403': *764 + user: *781 + '400': *767 + '401': *765 + '403': *768 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *775 + '429': *769 + '500': *770 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -114575,15 +116209,15 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user parameters: - - *778 + - *782 - *39 requestBody: required: true content: application/json: - schema: *781 + schema: *785 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -114623,18 +116257,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *776 + schema: *780 examples: - userMultiValuedProperties: *777 - userSingleValuedProperties: *777 - disableUser: *777 - '400': *763 - '401': *761 - '403': *764 + userMultiValuedProperties: *781 + userSingleValuedProperties: *781 + disableUser: *781 + '400': *767 + '401': *765 + '403': *768 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *775 + '429': *769 + '500': *770 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -114652,19 +116286,19 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise parameters: - - *778 + - *782 - *39 responses: '204': description: User was deleted, no content - '400': *763 - '401': *761 - '403': *764 + '400': *767 + '401': *765 + '403': *768 '404': *6 - '429': *765 - '500': *766 + '429': *769 + '500': *770 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -114695,7 +116329,7 @@ paths: operationId: scim/list-provisioned-identities externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities + url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#list-scim-provisioned-identities parameters: - *87 - name: startIndex @@ -114755,7 +116389,7 @@ paths: - 1 Resources: type: array - items: &782 + items: &786 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -115002,22 +116636,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *35 - '404': &783 + '404': &787 description: Resource not found content: application/json: - schema: *760 + schema: *764 application/scim+json: - schema: *760 - '403': &784 + schema: *764 + '403': &788 description: Forbidden content: application/json: - schema: *760 + schema: *764 application/scim+json: - schema: *760 - '400': *763 - '429': *765 + schema: *764 + '400': *767 + '429': *769 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -115029,13 +116663,13 @@ paths: email to the email address. If the user was previously a member of the organization, the invitation will reinstate any former privileges that the user had. For more information about reinstating former members, see "[Reinstating a former - member of your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization)." + member of your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization)." tags: - scim operationId: scim/provision-and-invite-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user + url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#provision-and-invite-a-scim-user parameters: - *87 responses: @@ -115043,9 +116677,9 @@ paths: description: Response content: application/scim+json: - schema: *782 + schema: *786 examples: - default: &785 + default: &789 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -115068,17 +116702,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *35 - '404': *783 - '403': *784 - '500': *766 + '404': *787 + '403': *788 + '500': *770 '409': description: Conflict content: application/json: - schema: *760 + schema: *764 application/scim+json: - schema: *760 - '400': *763 + schema: *764 + '400': *767 requestBody: required: true content: @@ -115175,20 +116809,20 @@ paths: operationId: scim/get-provisioning-information-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - *87 - - *778 + - *782 responses: '200': description: Response content: application/scim+json: - schema: *782 + schema: *786 examples: - default: *785 - '404': *783 - '403': *784 + default: *789 + '404': *787 + '403': *788 '304': *35 x-github: githubCloudOnly: true @@ -115198,7 +116832,7 @@ paths: put: summary: Update a provisioned organization membership description: |- - Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user) endpoint instead. + Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-an-attribute-for-a-scim-user) endpoint instead. You must at least provide the required values for the user: `userName`, `name`, and `emails`. @@ -115209,21 +116843,21 @@ paths: operationId: scim/set-information-for-provisioned-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership + url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-a-provisioned-organization-membership parameters: - *87 - - *778 + - *782 responses: '200': description: Response content: application/scim+json: - schema: *782 + schema: *786 examples: - default: *785 + default: *789 '304': *35 - '404': *783 - '403': *784 + '404': *787 + '403': *788 requestBody: required: true content: @@ -115335,22 +116969,22 @@ paths: operationId: scim/update-attribute-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user + url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - *87 - - *778 + - *782 responses: '200': description: Response content: application/scim+json: - schema: *782 + schema: *786 examples: - default: *785 + default: *789 '304': *35 - '404': *783 - '403': *784 - '400': *763 + '404': *787 + '403': *788 + '400': *767 '429': description: Response content: @@ -115443,15 +117077,15 @@ paths: operationId: scim/delete-user-from-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization + url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - *87 - - *778 + - *782 responses: '204': description: Response - '404': *783 - '403': *784 + '404': *787 + '403': *788 '304': *35 x-github: githubCloudOnly: true @@ -115462,9 +117096,9 @@ paths: get: summary: Search code description: |- - Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). + Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api). - When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). + When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata). For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: @@ -115482,7 +117116,7 @@ paths: language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. + > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. This endpoint requires you to authenticate and limits you to 10 requests per minute. tags: @@ -115490,15 +117124,15 @@ paths: operationId: search/code externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code + url: https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-code parameters: - name: q description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see - [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). - See "[Searching code](https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-code)" + [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). + See "[Searching code](https://docs.github.com/enterprise-cloud@latest/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. in: query required: true @@ -115508,7 +117142,7 @@ paths: deprecated: true description: "**This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed - by the GitHub Enterprise Cloud search infrastructure. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)" + by the GitHub Enterprise Cloud search infrastructure. Default: [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)" in: query required: false schema: @@ -115588,7 +117222,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &786 + text_matches: &790 title: Search Result Text Matches type: array items: @@ -115715,10 +117349,10 @@ paths: get: summary: Search commits description: |- - Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). + Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api). When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match - metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). + metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata). For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: @@ -115728,15 +117362,15 @@ paths: operationId: search/commits externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-commits + url: https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-commits parameters: - name: q description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see - [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). - See "[Searching commits](https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-commits)" + [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). + See "[Searching commits](https://docs.github.com/enterprise-cloud@latest/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. in: query required: true @@ -115744,7 +117378,7 @@ paths: type: string - name: sort description: 'Sorts the results of your query by `author-date` or `committer-date`. - Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)' + Default: [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)' in: query required: false schema: @@ -115752,7 +117386,7 @@ paths: enum: - author-date - committer-date - - &787 + - &791 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -115821,7 +117455,7 @@ paths: committer: anyOf: - type: 'null' - - *512 + - *516 comment_count: type: integer message: @@ -115840,7 +117474,7 @@ paths: url: type: string format: uri - verification: *636 + verification: *640 required: - author - committer @@ -115855,7 +117489,7 @@ paths: committer: anyOf: - type: 'null' - - *512 + - *516 parents: type: array items: @@ -115872,7 +117506,7 @@ paths: type: number node_id: type: string - text_matches: *786 + text_matches: *790 required: - sha - node_id @@ -116011,10 +117645,10 @@ paths: get: summary: Search issues and pull requests description: |- - Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). + Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api). When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). + search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata). For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. @@ -116023,21 +117657,21 @@ paths: This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. > [!NOTE] - > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." tags: - search operationId: search/issues-and-pull-requests externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-issues-and-pull-requests + url: https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-issues-and-pull-requests parameters: - name: q description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see - [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). - See "[Searching issues and pull requests](https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-issues-and-pull-requests)" + [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). + See "[Searching issues and pull requests](https://docs.github.com/enterprise-cloud@latest/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. in: query required: true @@ -116048,7 +117682,7 @@ paths: `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: - [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)' + [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)' in: query required: false schema: @@ -116065,7 +117699,7 @@ paths: - interactions - created - updated - - *787 + - *791 - *17 - *19 - name: advanced_search @@ -116179,11 +117813,11 @@ paths: type: - string - 'null' - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *792 + issue_dependencies_summary: *793 issue_field_values: type: array - items: *658 + items: *662 state: type: string state_reason: @@ -116197,7 +117831,7 @@ paths: milestone: anyOf: - type: 'null' - - *410 + - *414 comments: type: integer created_at: @@ -116211,7 +117845,7 @@ paths: - string - 'null' format: date-time - text_matches: *786 + text_matches: *790 pull_request: type: object properties: @@ -116260,7 +117894,7 @@ paths: timeline_url: type: string format: uri - type: *376 + type: *380 performed_via_github_app: anyOf: - type: 'null' @@ -116437,9 +118071,9 @@ paths: get: summary: Search labels description: |- - Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). + Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api). - When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). + When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata). For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: @@ -116451,7 +118085,7 @@ paths: operationId: search/labels externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-labels + url: https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-labels parameters: - name: repository_id description: The id of the repository. @@ -116462,14 +118096,14 @@ paths: - name: q description: The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing - a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). + a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). in: query required: true schema: type: string - name: sort description: 'Sorts the results of your query by when the label was `created` - or `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)' + or `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)' in: query required: false schema: @@ -116477,7 +118111,7 @@ paths: enum: - created - updated - - *787 + - *791 - *17 - *19 responses: @@ -116522,7 +118156,7 @@ paths: - 'null' score: type: number - text_matches: *786 + text_matches: *790 required: - id - node_id @@ -116567,9 +118201,9 @@ paths: get: summary: Search repositories description: |- - Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). + Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api). - When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). + When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata). For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: @@ -116581,15 +118215,15 @@ paths: operationId: search/repos externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-repositories parameters: - name: q description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see - [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). - See "[Searching for repositories](https://docs.github.com/enterprise-cloud@latest//articles/searching-for-repositories/)" + [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). + See "[Searching for repositories](https://docs.github.com/enterprise-cloud@latest/articles/searching-for-repositories/)" for a detailed list of qualifiers. in: query required: true @@ -116598,7 +118232,7 @@ paths: - name: sort description: 'Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: - [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)' + [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)' in: query required: false schema: @@ -116608,7 +118242,7 @@ paths: - forks - help-wanted-issues - updated - - *787 + - *791 - *17 - *19 responses: @@ -116854,7 +118488,7 @@ paths: - admin - pull - push - text_matches: *786 + text_matches: *790 temp_clone_token: type: string allow_merge_commit: @@ -117069,9 +118703,9 @@ paths: get: summary: Search topics description: |- - Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-cloud@latest//articles/searching-topics/)" for a detailed list of qualifiers. + Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-cloud@latest/articles/searching-topics/)" for a detailed list of qualifiers. - When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). + When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata). For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: @@ -117083,14 +118717,14 @@ paths: operationId: search/topics externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-topics + url: https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-topics parameters: - name: q description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see - [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). + [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). in: query required: true schema: @@ -117163,7 +118797,7 @@ paths: - string - 'null' format: uri - text_matches: *786 + text_matches: *790 related: type: - array @@ -117316,9 +118950,9 @@ paths: get: summary: Search users description: |- - Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). + Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api). - When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). + When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata). For example, if you're looking for a list of popular users, you might try this query: @@ -117326,21 +118960,21 @@ paths: This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. - This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-cloud@latest//graphql/reference/queries#search)." + This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-cloud@latest/graphql/reference/queries#search)." tags: - search operationId: search/users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-users + url: https://docs.github.com/enterprise-cloud@latest/rest/search/search#search-users parameters: - name: q description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see - [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). - See "[Searching users](https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-users)" + [Constructing a search query](https://docs.github.com/enterprise-cloud@latest/rest/search/search#constructing-a-search-query). + See "[Searching users](https://docs.github.com/enterprise-cloud@latest/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. in: query required: true @@ -117349,7 +118983,7 @@ paths: - name: sort description: 'Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Cloud. Default: - [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)' + [best match](https://docs.github.com/enterprise-cloud@latest/rest/search/search#ranking-search-results)' in: query required: false schema: @@ -117358,7 +118992,7 @@ paths: - followers - repositories - joined - - *787 + - *791 - *17 - *19 responses: @@ -117468,7 +119102,7 @@ paths: type: - boolean - 'null' - text_matches: *786 + text_matches: *790 blog: type: - string @@ -117542,15 +119176,15 @@ paths: summary: Get a team (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#get-a-team-by-name) endpoint. tags: - teams operationId: teams/get-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#get-a-team-legacy parameters: - - &790 + - &794 name: team_id description: The unique identifier of the team. in: path @@ -117562,9 +119196,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *457 examples: - default: *454 + default: *458 '404': *6 x-github: githubCloudOnly: false @@ -117578,7 +119212,7 @@ paths: summary: Update a team (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#update-a-team) endpoint. To edit a team, the authenticated user must either be an organization owner or a team maintainer. @@ -117589,9 +119223,9 @@ paths: operationId: teams/update-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#update-a-team-legacy parameters: - - *790 + - *794 requestBody: required: true content: @@ -117655,16 +119289,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *453 + schema: *457 examples: - default: *454 + default: *458 '201': description: Response content: application/json: - schema: *453 + schema: *457 examples: - default: *454 + default: *458 '404': *6 '422': *15 '403': *27 @@ -117680,7 +119314,7 @@ paths: summary: Delete a team (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#delete-a-team) endpoint. To delete a team, the authenticated user must be an organization owner or team maintainer. @@ -117690,9 +119324,9 @@ paths: operationId: teams/delete-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#delete-a-team-legacy parameters: - - *790 + - *794 responses: '204': description: Response @@ -117711,7 +119345,7 @@ paths: summary: List pending team invitations (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-pending-team-invitations) endpoint. The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`. tags: @@ -117719,9 +119353,9 @@ paths: operationId: teams/list-pending-invitations-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *790 + - *794 - *17 - *19 responses: @@ -117731,9 +119365,9 @@ paths: application/json: schema: type: array - items: *370 + items: *374 examples: - default: *371 + default: *375 headers: Link: *45 x-github: @@ -117749,7 +119383,7 @@ paths: summary: List team members (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-team-members) endpoint. Team members will include the members of child teams. tags: @@ -117757,9 +119391,9 @@ paths: operationId: teams/list-members-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-team-members-legacy parameters: - - *790 + - *794 - name: role description: Filters members returned by their role in the team. in: query @@ -117800,7 +119434,7 @@ paths: description: |- The "Get team member" endpoint (described below) is closing down. - We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. + We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. To list members in a team, the team must be visible to the authenticated user. tags: @@ -117808,9 +119442,9 @@ paths: operationId: teams/get-member-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-member-legacy parameters: - - *790 + - *794 - *140 responses: '204': @@ -117830,24 +119464,24 @@ paths: description: |- The "Add team member" endpoint (described below) is closing down. - We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. + We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. > [!NOTE] - > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - teams operationId: teams/add-member-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-team-member-legacy parameters: - - *790 + - *794 - *140 responses: '204': @@ -117872,22 +119506,22 @@ paths: description: |- The "Remove team member" endpoint (described below) is closing down. - We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. + We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. > [!NOTE] - > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." tags: - teams operationId: teams/remove-member-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-member-legacy parameters: - - *790 + - *794 - *140 responses: '204': @@ -117907,7 +119541,7 @@ paths: summary: Get team membership for a user (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-membership-for-a-user) endpoint. Team members will include the members of child teams. @@ -117916,24 +119550,24 @@ paths: **Note:** The response contains the `state` of the membership and the member's `role`. - The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team). + The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#create-a-team). tags: - teams operationId: teams/get-membership-for-user-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *790 + - *794 - *140 responses: '200': description: Response content: application/json: - schema: *460 + schema: *464 examples: - response-if-user-is-a-team-maintainer: *791 + response-if-user-is-a-team-maintainer: *795 '404': *6 x-github: githubCloudOnly: false @@ -117947,14 +119581,14 @@ paths: summary: Add or update team membership for a user (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. > [!NOTE] - > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. @@ -117964,9 +119598,9 @@ paths: operationId: teams/add-or-update-membership-for-user-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *790 + - *794 - *140 requestBody: required: false @@ -117992,9 +119626,9 @@ paths: description: Response content: application/json: - schema: *460 + schema: *464 examples: - response-if-users-membership-with-team-is-now-pending: *792 + response-if-users-membership-with-team-is-now-pending: *796 '403': description: Forbidden if team synchronization is set up '422': @@ -118013,22 +119647,22 @@ paths: summary: Remove team membership for a user (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-membership-for-a-user) endpoint. - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. > [!NOTE] - > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." tags: - teams operationId: teams/remove-membership-for-user-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *790 + - *794 - *140 responses: '204': @@ -118048,15 +119682,15 @@ paths: summary: List team repositories (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-team-repositories) endpoint. tags: - teams operationId: teams/list-repos-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-team-repositories-legacy parameters: - - *790 + - *794 - *17 - *19 responses: @@ -118068,7 +119702,7 @@ paths: type: array items: *278 examples: - default: *397 + default: *401 headers: Link: *45 '404': *6 @@ -118085,28 +119719,28 @@ paths: summary: Check team permissions for a repository (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. > [!NOTE] > Repositories inherited through a parent team will also be checked. - You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: + You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: tags: - teams operationId: teams/check-permissions-for-repo-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *790 - - *461 - - *462 + - *794 + - *465 + - *466 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *793 + schema: *797 examples: alternative-response-with-extra-repository-information: value: @@ -118245,21 +119879,21 @@ paths: summary: Add or update team repository permissions (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. - Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - teams operationId: teams/add-or-update-repo-permissions-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *790 - - *461 - - *462 + - *794 + - *465 + - *466 requestBody: required: false content: @@ -118299,7 +119933,7 @@ paths: summary: Remove a repository from a team (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#remove-a-repository-from-a-team) endpoint. If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. tags: @@ -118307,11 +119941,11 @@ paths: operationId: teams/remove-repo-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *790 - - *461 - - *462 + - *794 + - *465 + - *466 responses: '204': description: Response @@ -118328,9 +119962,9 @@ paths: summary: List IdP groups for a team (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#list-idp-groups-for-a-team) endpoint. - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. List IdP groups connected to a team on GitHub Enterprise Cloud. tags: @@ -118338,17 +119972,17 @@ paths: operationId: teams/list-idp-groups-for-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#list-idp-groups-for-a-team-legacy parameters: - - *790 + - *794 responses: '200': description: Response content: application/json: - schema: *463 + schema: *467 examples: - default: *464 + default: *468 '403': *27 '404': *6 x-github: @@ -118363,9 +119997,9 @@ paths: summary: Create or update IdP group connections (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#create-or-update-idp-group-connections) endpoint. - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. tags: @@ -118373,9 +120007,9 @@ paths: operationId: teams/create-or-update-idp-group-connections-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#create-or-update-idp-group-connections-legacy parameters: - - *790 + - *794 requestBody: required: true content: @@ -118436,7 +120070,7 @@ paths: description: Response content: application/json: - schema: *463 + schema: *467 examples: default: value: @@ -118459,15 +120093,15 @@ paths: summary: List child teams (Legacy) description: |- > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-child-teams) endpoint. tags: - teams operationId: teams/list-child-legacy externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-child-teams-legacy parameters: - - *790 + - *794 - *17 - *19 responses: @@ -118479,7 +120113,7 @@ paths: type: array items: *307 examples: - response-if-child-teams-exist: *794 + response-if-child-teams-exist: *798 headers: Link: *45 '404': *6 @@ -118503,7 +120137,7 @@ paths: operationId: users/get-authenticated externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/users#get-the-authenticated-user parameters: [] responses: '200': @@ -118512,7 +120146,7 @@ paths: application/json: schema: oneOf: - - &796 + - &800 title: Private User description: Private User type: object @@ -118762,7 +120396,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *795 + - *799 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -118864,7 +120498,7 @@ paths: operationId: users/update-authenticated externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#update-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/users#update-the-authenticated-user parameters: [] requestBody: required: false @@ -118922,7 +120556,7 @@ paths: description: Response content: application/json: - schema: *796 + schema: *800 examples: default: value: @@ -118988,7 +120622,7 @@ paths: operationId: users/list-blocked-by-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#list-users-blocked-by-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/blocking#list-users-blocked-by-the-authenticated-user parameters: - *17 - *19 @@ -119022,7 +120656,7 @@ paths: operationId: users/check-blocked externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - *140 responses: @@ -119050,7 +120684,7 @@ paths: operationId: users/block externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/blocking#block-a-user parameters: - *140 responses: @@ -119074,7 +120708,7 @@ paths: operationId: users/unblock externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/blocking#unblock-a-user parameters: - *140 responses: @@ -119101,7 +120735,7 @@ paths: operationId: codespaces/list-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#list-codespaces-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#list-codespaces-for-the-authenticated-user parameters: - *17 - *19 @@ -119125,9 +120759,9 @@ paths: type: integer codespaces: type: array - items: *381 + items: *385 examples: - default: *382 + default: *386 '304': *35 '500': *38 '401': *23 @@ -119151,7 +120785,7 @@ paths: operationId: codespaces/create-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-for-the-authenticated-user requestBody: required: true content: @@ -119266,17 +120900,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *381 + schema: *385 examples: - default: *564 + default: *568 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *381 + schema: *385 examples: - default: *564 + default: *568 '401': *23 '403': *27 '404': *6 @@ -119301,7 +120935,7 @@ paths: operationId: codespaces/list-secrets-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-secrets-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#list-secrets-for-the-authenticated-user parameters: - *17 - *19 @@ -119320,7 +120954,7 @@ paths: type: integer secrets: type: array - items: &797 + items: &801 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -119362,7 +120996,7 @@ paths: - visibility - selected_repositories_url examples: - default: *566 + default: *570 headers: Link: *45 x-github: @@ -119384,7 +121018,7 @@ paths: operationId: codespaces/get-public-key-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-public-key-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#get-public-key-for-the-authenticated-user responses: '200': description: Response @@ -119432,7 +121066,7 @@ paths: operationId: codespaces/get-secret-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-a-secret-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - *288 responses: @@ -119440,7 +121074,7 @@ paths: description: Response content: application/json: - schema: *797 + schema: *801 examples: default: value: @@ -119458,7 +121092,7 @@ paths: summary: Create or update a secret for the authenticated user description: |- Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." The authenticated user must have Codespaces access to use this endpoint. @@ -119468,7 +121102,7 @@ paths: operationId: codespaces/create-or-update-secret-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - *288 requestBody: @@ -119482,7 +121116,7 @@ paths: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for - the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-public-key-for-the-authenticated-user) + the authenticated user](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: @@ -119492,9 +121126,9 @@ paths: type: array description: An array of repository ids that can access the user secret. You can manage the list of selected repositories using - the [List selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), - [Set selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), - and [Remove a selected repository from a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) + the [List selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), + [Set selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), + and [Remove a selected repository from a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints. items: anyOf: @@ -119541,7 +121175,7 @@ paths: operationId: codespaces/delete-secret-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - *288 responses: @@ -119566,7 +121200,7 @@ paths: operationId: codespaces/list-repositories-for-secret-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - *288 responses: @@ -119586,7 +121220,7 @@ paths: type: array items: *278 examples: - default: *322 + default: *326 '401': *23 '403': *27 '404': *6 @@ -119609,7 +121243,7 @@ paths: operationId: codespaces/set-repositories-for-secret-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#set-selected-repositories-for-a-user-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - *288 requestBody: @@ -119623,9 +121257,9 @@ paths: type: array description: An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories - using the [List selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), - [Add a selected repository to a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), - and [Remove a selected repository from a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) + using the [List selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), + [Add a selected repository to a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), + and [Remove a selected repository from a user secret](https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints. items: type: integer @@ -119663,7 +121297,7 @@ paths: operationId: codespaces/add-repository-for-secret-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - *288 - name: repository_id @@ -119696,7 +121330,7 @@ paths: operationId: codespaces/remove-repository-for-secret-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - *288 - name: repository_id @@ -119728,17 +121362,17 @@ paths: operationId: codespaces/get-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *383 + - *387 responses: '200': description: Response content: application/json: - schema: *381 + schema: *385 examples: - default: *564 + default: *568 '304': *35 '500': *38 '401': *23 @@ -119762,9 +121396,9 @@ paths: operationId: codespaces/update-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *383 + - *387 requestBody: required: false content: @@ -119794,9 +121428,9 @@ paths: description: Response content: application/json: - schema: *381 + schema: *385 examples: - default: *564 + default: *568 '401': *23 '403': *27 '404': *6 @@ -119816,9 +121450,9 @@ paths: operationId: codespaces/delete-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *383 + - *387 responses: '202': *37 '304': *35 @@ -119845,15 +121479,15 @@ paths: operationId: codespaces/export-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *383 + - *387 responses: '202': description: Response content: application/json: - schema: &798 + schema: &802 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -119906,7 +121540,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &799 + default: &803 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -119936,9 +121570,9 @@ paths: operationId: codespaces/get-export-details-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *383 + - *387 - name: export_id in: path required: true @@ -119951,9 +121585,9 @@ paths: description: Response content: application/json: - schema: *798 + schema: *802 examples: - default: *799 + default: *803 '404': *6 x-github: githubCloudOnly: false @@ -119972,9 +121606,9 @@ paths: operationId: codespaces/codespace-machines-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *383 + - *387 responses: '200': description: Response @@ -119990,9 +121624,9 @@ paths: type: integer machines: type: array - items: *565 + items: *569 examples: - default: *800 + default: *804 '304': *35 '500': *38 '401': *23 @@ -120019,9 +121653,9 @@ paths: operationId: codespaces/publish-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *383 + - *387 requestBody: required: true content: @@ -120077,11 +121711,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *466 + repository: *470 machine: anyOf: - type: 'null' - - *565 + - *569 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -120876,17 +122510,17 @@ paths: operationId: codespaces/start-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *383 + - *387 responses: '200': description: Response content: application/json: - schema: *381 + schema: *385 examples: - default: *564 + default: *568 '304': *35 '500': *38 '400': *14 @@ -120916,17 +122550,17 @@ paths: operationId: codespaces/stop-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *383 + - *387 responses: '200': description: Response content: application/json: - schema: *381 + schema: *385 examples: - default: *564 + default: *568 '500': *38 '401': *23 '403': *27 @@ -120948,7 +122582,7 @@ paths: operationId: packages/list-docker-migration-conflicting-packages-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user responses: '200': description: Response @@ -120956,9 +122590,9 @@ paths: application/json: schema: type: array - items: *391 + items: *395 examples: - default: &811 + default: &815 value: - id: 197 name: hello_docker @@ -121030,7 +122664,7 @@ paths: operationId: users/set-primary-email-visibility-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/emails#set-primary-email-visibility-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user parameters: [] requestBody: required: true @@ -121059,7 +122693,7 @@ paths: application/json: schema: type: array - items: &801 + items: &805 title: Email description: Email type: object @@ -121118,7 +122752,7 @@ paths: operationId: users/list-emails-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/emails#list-email-addresses-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/emails#list-email-addresses-for-the-authenticated-user parameters: - *17 - *19 @@ -121129,9 +122763,9 @@ paths: application/json: schema: type: array - items: *801 + items: *805 examples: - default: &813 + default: &817 value: - email: octocat@github.com verified: true @@ -121157,7 +122791,7 @@ paths: operationId: users/add-email-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/emails#add-an-email-address-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/emails#add-an-email-address-for-the-authenticated-user parameters: [] requestBody: required: false @@ -121208,7 +122842,7 @@ paths: application/json: schema: type: array - items: *801 + items: *805 examples: default: value: @@ -121243,7 +122877,7 @@ paths: operationId: users/delete-email-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/emails#delete-an-email-address-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/emails#delete-an-email-address-for-the-authenticated-user parameters: [] requestBody: content: @@ -121307,7 +122941,7 @@ paths: operationId: users/list-followers-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/followers#list-followers-of-the-authenticated-user parameters: - *17 - *19 @@ -121340,7 +122974,7 @@ paths: operationId: users/list-followed-by-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-the-authenticated-user-follows + url: https://docs.github.com/enterprise-cloud@latest/rest/users/followers#list-the-people-the-authenticated-user-follows parameters: - *17 - *19 @@ -121373,7 +123007,7 @@ paths: operationId: users/check-person-is-followed-by-authenticated externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - *140 responses: @@ -121395,7 +123029,7 @@ paths: put: summary: Follow a user description: |- - Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method)." OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. tags: @@ -121403,7 +123037,7 @@ paths: operationId: users/follow externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/followers#follow-a-user parameters: - *140 responses: @@ -121428,7 +123062,7 @@ paths: operationId: users/unfollow externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/followers#unfollow-a-user parameters: - *140 responses: @@ -121455,7 +123089,7 @@ paths: operationId: users/list-gpg-keys-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user parameters: - *17 - *19 @@ -121466,7 +123100,7 @@ paths: application/json: schema: type: array - items: &802 + items: &806 title: GPG Key description: A unique encryption key type: object @@ -121611,7 +123245,7 @@ paths: - subkeys - revoked examples: - default: &829 + default: &834 value: - id: 3 name: Octocat's GPG Key @@ -121664,7 +123298,7 @@ paths: - users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user parameters: [] requestBody: required: true @@ -121696,9 +123330,9 @@ paths: description: Response content: application/json: - schema: *802 + schema: *806 examples: - default: &803 + default: &807 value: id: 3 name: Octocat's GPG Key @@ -121753,9 +123387,9 @@ paths: operationId: users/get-gpg-key-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &804 + - &808 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -121767,9 +123401,9 @@ paths: description: Response content: application/json: - schema: *802 + schema: *806 examples: - default: *803 + default: *807 '404': *6 '304': *35 '403': *27 @@ -121790,9 +123424,9 @@ paths: operationId: users/delete-gpg-key-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *804 + - *808 responses: '204': description: Response @@ -121820,7 +123454,7 @@ paths: operationId: apps/list-installations-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#list-app-installations-accessible-to-the-user-access-token + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token parameters: - *17 - *19 @@ -121958,7 +123592,7 @@ paths: operationId: apps/list-installation-repos-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#list-repositories-accessible-to-the-user-access-token + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#list-repositories-accessible-to-the-user-access-token parameters: - *21 - *17 @@ -122008,7 +123642,7 @@ paths: operationId: apps/add-repo-to-installation-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - *272 @@ -122034,7 +123668,7 @@ paths: operationId: apps/remove-repo-from-installation-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - *272 @@ -122063,7 +123697,7 @@ paths: operationId: interactions/get-restrictions-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/user#get-interaction-restrictions-for-your-public-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/user#get-interaction-restrictions-for-your-public-repositories responses: '200': description: Default response @@ -122071,12 +123705,12 @@ paths: application/json: schema: anyOf: - - *368 + - *372 - type: object properties: {} additionalProperties: false examples: - default: *369 + default: *373 '204': description: Response when there are no restrictions x-github: @@ -122095,12 +123729,12 @@ paths: operationId: interactions/set-restrictions-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/user#set-interaction-restrictions-for-your-public-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/user#set-interaction-restrictions-for-your-public-repositories requestBody: required: true content: application/json: - schema: *646 + schema: *650 examples: default: value: @@ -122111,7 +123745,7 @@ paths: description: Response content: application/json: - schema: *368 + schema: *372 examples: default: value: @@ -122132,7 +123766,7 @@ paths: operationId: interactions/remove-restrictions-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/user#remove-interaction-restrictions-from-your-public-repositories + url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/user#remove-interaction-restrictions-from-your-public-repositories responses: '204': description: Response @@ -122148,9 +123782,9 @@ paths: List issues across owned and member repositories assigned to the authenticated user. > [!NOTE] - > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests)" endpoint. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -122161,7 +123795,7 @@ paths: operationId: issues/list-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user parameters: - name: filter description: Indicates which sorts of issues to return. `assigned` means issues @@ -122192,7 +123826,7 @@ paths: - closed - all default: open - - *379 + - *383 - name: sort description: What to sort results by. in: query @@ -122217,7 +123851,7 @@ paths: type: array items: *219 examples: - default: *380 + default: *384 headers: Link: *45 '404': *6 @@ -122239,7 +123873,7 @@ paths: operationId: users/list-public-ssh-keys-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-ssh-keys-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user parameters: - *17 - *19 @@ -122250,7 +123884,7 @@ paths: application/json: schema: type: array - items: &805 + items: &809 title: Key description: Key type: object @@ -122323,7 +123957,7 @@ paths: - users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user parameters: [] requestBody: required: true @@ -122353,9 +123987,9 @@ paths: description: Response content: application/json: - schema: *805 + schema: *809 examples: - default: &806 + default: &810 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -122386,17 +124020,17 @@ paths: operationId: users/get-public-ssh-key-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *677 + - *681 responses: '200': description: Response content: application/json: - schema: *805 + schema: *809 examples: - default: *806 + default: *810 '404': *6 '304': *35 '403': *27 @@ -122417,9 +124051,9 @@ paths: operationId: users/delete-public-ssh-key-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *677 + - *681 responses: '204': description: Response @@ -122441,7 +124075,7 @@ paths: operationId: apps/list-subscriptions-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-subscriptions-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user parameters: - *17 - *19 @@ -122452,7 +124086,7 @@ paths: application/json: schema: type: array - items: &807 + items: &811 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -122531,7 +124165,7 @@ paths: - account - plan examples: - default: &808 + default: &812 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -122582,7 +124216,7 @@ paths: operationId: apps/list-subscriptions-for-authenticated-user-stubbed externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed parameters: - *17 - *19 @@ -122593,9 +124227,9 @@ paths: application/json: schema: type: array - items: *807 + items: *811 examples: - default: *808 + default: *812 headers: Link: *45 '304': *35 @@ -122614,7 +124248,7 @@ paths: operationId: orgs/list-memberships-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-memberships-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#list-organization-memberships-for-the-authenticated-user parameters: - name: state description: Indicates the state of the memberships to return. If not specified, @@ -122635,7 +124269,7 @@ paths: application/json: schema: type: array - items: *384 + items: *388 examples: default: value: @@ -122741,7 +124375,7 @@ paths: operationId: orgs/get-membership-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-an-organization-membership-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - *87 responses: @@ -122749,7 +124383,7 @@ paths: description: Response content: application/json: - schema: *384 + schema: *388 examples: default: value: @@ -122809,7 +124443,7 @@ paths: operationId: orgs/update-membership-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#update-an-organization-membership-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - *87 requestBody: @@ -122836,7 +124470,7 @@ paths: description: Response content: application/json: - schema: *384 + schema: *388 examples: default: value: @@ -122897,7 +124531,7 @@ paths: operationId: migrations/list-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-user-migrations + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#list-user-migrations parameters: - *17 - *19 @@ -122908,7 +124542,7 @@ paths: application/json: schema: type: array - items: *386 + items: *390 examples: default: value: @@ -123078,7 +124712,7 @@ paths: operationId: migrations/start-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#start-a-user-migration + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#start-a-user-migration parameters: [] requestBody: required: true @@ -123170,7 +124804,7 @@ paths: description: Response content: application/json: - schema: *386 + schema: *390 examples: default: value: @@ -123342,15 +124976,15 @@ paths: * `exported` - the migration finished successfully. * `failed` - the migration failed. - Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive). + Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#download-a-user-migration-archive). tags: - migrations operationId: migrations/get-status-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#get-a-user-migration-status parameters: - - *387 + - *391 - name: exclude in: query required: false @@ -123363,7 +124997,7 @@ paths: description: Response content: application/json: - schema: *386 + schema: *390 examples: default: value: @@ -123555,9 +125189,9 @@ paths: operationId: migrations/get-archive-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#download-a-user-migration-archive parameters: - - *387 + - *391 responses: '302': description: Response @@ -123573,17 +125207,17 @@ paths: summary: Delete a user migration archive description: Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned - in the [List user migrations](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-user-migrations) - and [Get a user migration status](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status) + in the [List user migrations](https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#list-user-migrations) + and [Get a user migration status](https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. tags: - migrations operationId: migrations/delete-archive-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#delete-a-user-migration-archive parameters: - - *387 + - *391 responses: '204': description: Response @@ -123600,9 +125234,9 @@ paths: delete: summary: Unlock a user repository description: Unlocks a repository. You can lock repositories when you [start - a user migration](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#start-a-user-migration). + a user migration](https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using - it again or [delete the repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository) + it again or [delete the repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. tags: @@ -123610,10 +125244,10 @@ paths: operationId: migrations/unlock-repo-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#unlock-a-user-repository parameters: - - *387 - - *809 + - *391 + - *813 responses: '204': description: Response @@ -123635,9 +125269,9 @@ paths: operationId: migrations/list-repos-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration + url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *387 + - *391 - *17 - *19 responses: @@ -123649,7 +125283,7 @@ paths: type: array items: *278 examples: - default: *397 + default: *401 headers: Link: *45 '404': *6 @@ -123673,7 +125307,7 @@ paths: operationId: orgs/list-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-organizations-for-the-authenticated-user parameters: - *17 - *19 @@ -123703,13 +125337,13 @@ paths: description: |- Lists packages owned by the authenticated user within the user's namespace. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/list-packages-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-packages-for-the-authenticated-users-namespace + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-packages-for-the-authenticated-users-namespace parameters: - name: package_type description: The type of supported package. Packages in GitHub's Gradle registry @@ -123728,7 +125362,7 @@ paths: - docker - nuget - container - - *810 + - *814 - *19 - *17 responses: @@ -123738,10 +125372,10 @@ paths: application/json: schema: type: array - items: *391 + items: *395 examples: - default: *811 - '400': *812 + default: *815 + '400': *816 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -123753,24 +125387,24 @@ paths: description: |- Gets a specific package for a package owned by the authenticated user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *393 - - *394 + - *397 + - *398 responses: '200': description: Response content: application/json: - schema: *391 + schema: *395 examples: - default: &830 + default: &835 value: id: 40201 name: octo-name @@ -123875,16 +125509,16 @@ paths: description: |- Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *393 - - *394 + - *397 + - *398 responses: '204': description: Response @@ -123906,16 +125540,16 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *393 - - *394 + - *397 + - *398 - name: token description: package token schema: @@ -123939,16 +125573,16 @@ paths: description: |- Lists package versions for a package owned by the authenticated user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-all-package-versions-for-package-owned-by-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *393 - - *394 + - *397 + - *398 - *19 - *17 - name: state @@ -123968,7 +125602,7 @@ paths: application/json: schema: type: array - items: *395 + items: *399 examples: default: value: @@ -124009,23 +125643,23 @@ paths: description: |- Gets a specific package version for a package owned by the authenticated user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-version-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *393 - - *394 - - *396 + - *397 + - *398 + - *400 responses: '200': description: Response content: application/json: - schema: *395 + schema: *399 examples: default: value: @@ -124053,17 +125687,17 @@ paths: The authenticated user must have admin permissions in the organization to use this endpoint. - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-version-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-version-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *393 - - *394 - - *396 + - *397 + - *398 + - *400 responses: '204': description: Response @@ -124085,17 +125719,17 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-version-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-version-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *393 - - *394 - - *396 + - *397 + - *398 + - *400 responses: '204': description: Response @@ -124112,7 +125746,7 @@ paths: summary: List public email addresses for the authenticated user description: |- Lists your publicly visible email address, which you can set with the - [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-cloud@latest/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. @@ -124121,7 +125755,7 @@ paths: operationId: users/list-public-emails-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/emails#list-public-email-addresses-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/emails#list-public-email-addresses-for-the-authenticated-user parameters: - *17 - *19 @@ -124132,9 +125766,9 @@ paths: application/json: schema: type: array - items: *801 + items: *805 examples: - default: *813 + default: *817 headers: Link: *45 '304': *35 @@ -124158,7 +125792,7 @@ paths: operationId: repos/list-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repositories-for-the-authenticated-user parameters: - name: visibility description: Limit results to repositories with the specified visibility. @@ -124247,7 +125881,7 @@ paths: type: array items: *78 examples: - default: &820 + default: &824 summary: Default response value: - id: 1296269 @@ -124389,7 +126023,7 @@ paths: operationId: repos/create-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-for-the-authenticated-user parameters: [] requestBody: required: true @@ -124565,9 +126199,9 @@ paths: description: Response content: application/json: - schema: *466 + schema: *470 examples: - default: *468 + default: *472 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -124594,7 +126228,7 @@ paths: operationId: repos/list-invitations-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user parameters: - *17 - *19 @@ -124605,9 +126239,9 @@ paths: application/json: schema: type: array - items: *648 + items: *652 examples: - default: *814 + default: *818 headers: Link: *45 '304': *35 @@ -124628,9 +126262,9 @@ paths: operationId: repos/accept-invitation-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *372 + - *376 responses: '204': description: Response @@ -124651,9 +126285,9 @@ paths: operationId: repos/decline-invitation-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation + url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *372 + - *376 responses: '204': description: Response @@ -124675,7 +126309,7 @@ paths: operationId: users/list-social-accounts-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#list-social-accounts-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user parameters: - *17 - *19 @@ -124686,7 +126320,7 @@ paths: application/json: schema: type: array - items: &815 + items: &819 title: Social account description: Social media account type: object @@ -124703,7 +126337,7 @@ paths: - provider - url examples: - default: &816 + default: &820 value: - provider: twitter url: https://twitter.com/github @@ -124729,7 +126363,7 @@ paths: operationId: users/add-social-account-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#add-social-accounts-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user parameters: [] requestBody: required: true @@ -124766,9 +126400,9 @@ paths: application/json: schema: type: array - items: *815 + items: *819 examples: - default: *816 + default: *820 '422': *15 '304': *35 '404': *6 @@ -124790,7 +126424,7 @@ paths: operationId: users/delete-social-account-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user parameters: [] requestBody: required: true @@ -124845,7 +126479,7 @@ paths: operationId: users/list-ssh-signing-keys-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user parameters: - *17 - *19 @@ -124856,7 +126490,7 @@ paths: application/json: schema: type: array - items: &817 + items: &821 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -124876,7 +126510,7 @@ paths: - title - created_at examples: - default: &844 + default: &849 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -124909,7 +126543,7 @@ paths: - users externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user parameters: [] requestBody: required: true @@ -124924,7 +126558,7 @@ paths: - Personal MacBook Air key: description: The public SSH key to add to your GitHub account. For - more information, see "[Checking for existing SSH keys](https://docs.github.com/enterprise-cloud@latest//authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." + more information, see "[Checking for existing SSH keys](https://docs.github.com/enterprise-cloud@latest/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." type: string pattern: "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com " @@ -124941,9 +126575,9 @@ paths: description: Response content: application/json: - schema: *817 + schema: *821 examples: - default: &818 + default: &822 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -124971,9 +126605,9 @@ paths: operationId: users/get-ssh-signing-key-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &819 + - &823 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -124985,9 +126619,9 @@ paths: description: Response content: application/json: - schema: *817 + schema: *821 examples: - default: *818 + default: *822 '404': *6 '304': *35 '403': *27 @@ -125008,9 +126642,9 @@ paths: operationId: users/delete-ssh-signing-key-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *819 + - *823 responses: '204': description: Response @@ -125029,7 +126663,7 @@ paths: description: |- Lists repositories the authenticated user has starred. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. tags: @@ -125037,9 +126671,9 @@ paths: operationId: activity/list-repos-starred-by-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &845 + - &850 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -125064,11 +126698,11 @@ paths: type: array items: *78 examples: - default-response: *820 + default-response: *824 application/vnd.github.v3.star+json: schema: type: array - items: &846 + items: &851 title: Starred Repository description: Starred Repository type: object @@ -125222,10 +126856,10 @@ paths: operationId: activity/check-repo-is-starred-by-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': description: Response if this repository is starred by you @@ -125245,16 +126879,16 @@ paths: put: summary: Star a repository for the authenticated user description: Note that you'll need to set `Content-Length` to zero when calling - out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - activity operationId: activity/star-repo-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#star-a-repository-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': description: Response @@ -125276,10 +126910,10 @@ paths: operationId: activity/unstar-repo-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#unstar-a-repository-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *461 - - *462 + - *465 + - *466 responses: '204': description: Response @@ -125301,7 +126935,7 @@ paths: operationId: activity/list-watched-repos-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#list-repositories-watched-by-the-authenticated-user parameters: - *17 - *19 @@ -125314,7 +126948,7 @@ paths: type: array items: *278 examples: - default: *397 + default: *401 headers: Link: *45 '304': *35 @@ -125340,7 +126974,7 @@ paths: operationId: teams/list-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-teams-for-the-authenticated-user parameters: - *17 - *19 @@ -125351,7 +126985,7 @@ paths: application/json: schema: type: array - items: *453 + items: *457 examples: default: value: @@ -125417,17 +127051,17 @@ paths: description: |- Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. - If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest//enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. + If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. - The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#authentication). + The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#authentication). - The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/enterprise-cloud@latest//rest/users/emails). + The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/enterprise-cloud@latest/rest/users/emails). tags: - users operationId: users/get-by-id externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id + url: https://docs.github.com/enterprise-cloud@latest/rest/users/users#get-a-user-using-their-id parameters: - *237 responses: @@ -125437,10 +127071,10 @@ paths: application/json: schema: oneOf: - - *796 - - *795 + - *800 + - *799 examples: - default-response: &824 + default-response: &828 summary: Default response value: login: octocat @@ -125475,7 +127109,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &825 + response-with-git-hub-plan-information: &829 summary: Response with GitHub plan information value: login: octocat @@ -125530,16 +127164,16 @@ paths: operationId: projects/create-draft-item-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/drafts#create-draft-item-for-user-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &822 + - &826 name: user_id description: The unique identifier of the user. in: path required: true schema: type: string - - *409 + - *413 requestBody: required: true description: Details of the draft item to create in the project. @@ -125573,9 +127207,9 @@ paths: description: Response content: application/json: - schema: *414 + schema: *418 examples: - draft_issue: *415 + draft_issue: *419 '304': *35 '403': *27 '401': *23 @@ -125590,15 +127224,15 @@ paths: description: |- Lists all users, in the order that they signed up on GitHub Enterprise Cloud. This list includes personal user accounts and organization accounts. - Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. + Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. tags: - users operationId: users/list externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users + url: https://docs.github.com/enterprise-cloud@latest/rest/users/users#list-users parameters: - - *821 + - *825 - *17 responses: '200': @@ -125631,10 +127265,10 @@ paths: operationId: projects/create-view-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/views#create-a-view-for-a-user-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *822 - - *409 + - *826 + - *413 requestBody: required: true content: @@ -125658,7 +127292,7 @@ paths: - board filter: type: string - description: The filter query for the view. See [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) + description: The filter query for the view. See [Filtering projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. examples: - is:issue is:open @@ -125708,17 +127342,17 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *823 + schema: *827 examples: table_view: summary: Response for creating a table view - value: *419 + value: *423 board_view: summary: Response for creating a board view with filter - value: *419 + value: *423 roadmap_view: summary: Response for creating a roadmap view - value: *419 + value: *423 '304': *35 '403': *27 '401': *23 @@ -125740,17 +127374,17 @@ paths: description: |- Provides publicly available information about someone with a GitHub account. - If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest//enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. + If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. - The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#authentication). + The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-rest-api#authentication). - The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/enterprise-cloud@latest//rest/users/emails). + The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/enterprise-cloud@latest/rest/users/emails). tags: - users operationId: users/get-by-username externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/users#get-a-user parameters: - *140 responses: @@ -125760,11 +127394,11 @@ paths: application/json: schema: oneOf: - - *796 - - *795 + - *800 + - *799 examples: - default-response: *824 - response-with-git-hub-plan-information: *825 + default-response: *828 + response-with-git-hub-plan-information: *829 '404': *6 x-github: githubCloudOnly: false @@ -125779,13 +127413,13 @@ paths: The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. - **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). tags: - users operationId: users/list-attestations-bulk externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations-by-bulk-subject-digests + url: https://docs.github.com/enterprise-cloud@latest/rest/users/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - *108 @@ -125814,8 +127448,8 @@ paths: required: - subject_digests examples: - default: *826 - withPredicateType: *827 + default: *830 + withPredicateType: *831 responses: '200': description: Response @@ -125869,7 +127503,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *828 + default: *832 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -125885,7 +127519,7 @@ paths: operationId: users/delete-attestations-bulk externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-in-bulk + url: https://docs.github.com/enterprise-cloud@latest/rest/users/attestations#delete-attestations-in-bulk parameters: - *140 requestBody: @@ -125950,7 +127584,7 @@ paths: operationId: users/delete-attestations-by-subject-digest externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-subject-digest + url: https://docs.github.com/enterprise-cloud@latest/rest/users/attestations#delete-attestations-by-subject-digest parameters: - *140 - name: subject_digest @@ -125981,7 +127615,7 @@ paths: operationId: users/delete-attestations-by-id externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-id + url: https://docs.github.com/enterprise-cloud@latest/rest/users/attestations#delete-attestations-by-id parameters: - *140 - name: attestation_id @@ -126010,13 +127644,13 @@ paths: The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. - **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). tags: - users operationId: users/list-attestations externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations + url: https://docs.github.com/enterprise-cloud@latest/rest/users/attestations#list-attestations parameters: - *17 - *108 @@ -126074,7 +127708,7 @@ paths: initiator: type: string examples: - default: *508 + default: *512 '201': description: Response content: @@ -126091,6 +127725,1244 @@ paths: enabledForGitHubApps: true category: users subcategory: attestations + "/users/{username}/copilot-spaces": + get: + summary: List Copilot Spaces for a user + description: |- + Lists Copilot Spaces owned by a user. The authenticated user must have read access to the user's Copilot Spaces. + + Only Spaces that are readable by the authenticated user are returned. This includes the user's own spaces, and public user spaces when accessing another user's spaces. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/copilot-spaces#list-copilot-spaces-for-a-user + parameters: + - *140 + - name: per_page + description: The number of results per page (max 100). + in: query + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: before + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + in: query + schema: + type: string + - name: after + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. + in: query + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - spaces + properties: + spaces: + type: array + description: The list of Copilot Spaces on this page of results. + items: *322 + examples: + default: + summary: Example response for listing user copilot spaces + value: + spaces: + - id: 42 + number: 1 + name: Personal Research Space + description: My personal space for research and development + owner: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-16T10:15:00Z' + updated_at: '2023-02-16T16:30:00Z' + html_url: https://github.com/copilot/spaces/octocat/1 + api_url: https://api.github.com/user/1/copilot-spaces/1 + - id: 43 + number: 2 + name: Learning Space + description: Space for learning new technologies + owner: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 3 + node_id: MDQ6VXNlcjM= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-17T08:20:00Z' + updated_at: '2023-02-17T14:45:00Z' + html_url: https://github.com/copilot/spaces/octocat/2 + api_url: https://api.github.com/user/1/copilot-spaces/2 + headers: + Link: *45 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + post: + summary: Create a Copilot Space for a user + description: |- + Creates a new Copilot Space owned by a user. Only the authenticated user can create spaces for their own account. + + Users can create personal Copilot Spaces for their individual use. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/copilot-spaces#create-a-copilot-space-for-a-user + parameters: + - *140 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - My Development Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Personal space for development assistance + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Help me with React development patterns and best practices + base_role: + type: string + enum: + - reader + - no_access + description: |- + The base role that determines default permissions for the space. + - `no_access`: No default access (default) + - `reader`: Makes the space publicly readable + Note: User spaces do not support writer or admin base roles. + default: no_access + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + required: + - name + examples: + default: + value: + name: My Development Space + description: Personal space for development assistance + general_instructions: Help me with React development patterns and + best practices + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 789012 + file_path: src/components/App.js + - resource_type: free_text + metadata: + name: Development Notes + text: Focus on clean code principles and modern React patterns + responses: + '201': + description: Response + content: + application/json: + schema: *322 + examples: + default: &833 + summary: Example response for a user copilot space + value: + id: 42 + number: 5 + name: My Development Space + description: Personal space for React development patterns + general_instructions: Focus on React functional components, hooks, + and modern development patterns + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2023-02-15T08:30:00Z' + updated_at: '2023-02-15T14:45:00Z' + html_url: https://github.com/copilot/spaces/octocat/5 + api_url: https://api.github.com/user/1/copilot-spaces/5 + base_role: no_access + resources_attributes: + - id: 789 + resource_type: github_file + metadata: + repository_id: 1234 + file_path: src/components/App.tsx + - id: 790 + resource_type: free_text + metadata: + name: React Best Practices + text: Use functional components with hooks + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + "/users/{username}/copilot-spaces/{space_number}": + get: + summary: Get a Copilot Space for a user + description: |- + Gets details about a specific Copilot Space owned by a user. The authenticated user must have read access to the Space. + + Private user spaces require the authenticated user to be the owner of the space. + Public user spaces are accessible to any authenticated user. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/copilot-spaces#get-a-copilot-space-for-a-user + parameters: + - *140 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *322 + examples: + default: *833 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + put: + summary: Set a Copilot Space for a user + description: |- + Updates a Copilot Space owned by a user. Only the authenticated user can update spaces for their own account. + + Users can update their personal Copilot Spaces. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/copilot-spaces#set-a-copilot-space-for-a-user + parameters: + - *140 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the Copilot Space. + examples: + - Updated Development Space + description: + type: string + description: A description of the Copilot Space. + examples: + - Updated personal space for development assistance + general_instructions: + type: string + maxLength: 4000 + description: General instructions for the Copilot Space. + examples: + - Updated instructions to help me with React development patterns + and best practices + base_role: + type: string + enum: + - reader + - no_access + description: |- + The base role that determines default permissions for the space. Changing this field requires admin permissions. + - `no_access`: No default access (default) + - `reader`: Makes the space publicly readable + Note: User spaces do not support writer or admin base roles. + resources_attributes: + type: array + description: Resources to attach to the space. + items: + type: object + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + - media_content + - uploaded_text_file + description: The type of resource. + metadata: + type: object + description: Metadata specific to the resource type. + properties: + repository_id: + type: integer + description: Repository ID for repository or file resources. + file_path: + type: string + description: File path for file resources. + text: + type: string + description: Text content for free text resources. + name: + type: string + description: Name for the resource. + number: + type: integer + description: Issue or PR number. + examples: + default: + value: + name: Updated Development Space + description: Updated personal space for development assistance + general_instructions: Updated instructions to help me with React + development patterns and best practices + resources_attributes: + - resource_type: github_file + metadata: + repository_id: 789012 + file_path: src/components/UpdatedApp.js + - id: 123 + _destroy: true + - id: 456 + resource_type: free_text + metadata: + name: Updated Development Notes + text: Updated focus on clean code principles and modern React + patterns + responses: + '200': + description: Response + content: + application/json: + schema: *322 + examples: + default: *833 + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: copilot-spaces + subcategory: copilot-spaces + delete: + summary: Delete a Copilot Space for a user + description: |- + Deletes a Copilot Space owned by a user. The authenticated user must be the owner of the space. + + **Warning:** This action is permanent and cannot be undone. Deleting a space will remove all associated resources and configurations. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/copilot-spaces#delete-a-copilot-space-for-a-user + parameters: + - *140 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '204': + description: The Copilot Space has been successfully deleted. + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: copilot-spaces + "/users/{username}/copilot-spaces/{space_number}/collaborators": + get: + summary: List collaborators for a Copilot Space for a user + description: |- + Lists all collaborators for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + Each collaborator entry specifies which user has access to the space and at what level (reader, writer, or admin). The space owner is excluded from this list. + + Team collaborators are not supported for user-owned Copilot Spaces. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-collaborators-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/collaborators#list-collaborators-for-a-copilot-space-for-a-user + parameters: + - *140 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - collaborators + properties: + collaborators: + type: array + description: The list of collaborators for this Copilot Space. + items: *324 + examples: + default: + value: + collaborators: + - actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + - actor_type: User + role: reader + login: github-user + id: 67890 + node_id: MDQ6VXNlcjY3ODkw + avatar_url: https://github.com/images/error/other_user.gif + gravatar_id: '' + url: https://api.github.com/users/github-user + html_url: https://github.com/github-user + followers_url: https://api.github.com/users/github-user/followers + following_url: https://api.github.com/users/github-user/following{/other_user} + gists_url: https://api.github.com/users/github-user/gists{/gist_id} + starred_url: https://api.github.com/users/github-user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github-user/subscriptions + organizations_url: https://api.github.com/users/github-user/orgs + repos_url: https://api.github.com/users/github-user/repos + events_url: https://api.github.com/users/github-user/events{/privacy} + received_events_url: https://api.github.com/users/github-user/received_events + type: User + user_view_type: public + site_admin: false + name: GitHub User + company: + blog: '' + location: + email: + hireable: + bio: + twitter_username: + public_repos: 5 + public_gists: 0 + followers: 10 + following: 5 + created_at: '2010-01-14T04:33:35Z' + updated_at: '2010-01-14T04:33:35Z' + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + post: + summary: Add a collaborator to a Copilot Space for a user + description: |- + Adds a collaborator to a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + Team collaborators are not supported for user-owned Copilot Spaces. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/add-collaborator-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/collaborators#add-a-collaborator-to-a-copilot-space-for-a-user + parameters: + - *140 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - actor_type + - actor_identifier + - role + properties: + actor_type: + type: string + enum: + - User + - Team + description: The type of actor (must be `User` for user-owned spaces; + `Team` will be rejected). + actor_identifier: + type: string + description: The username of the collaborator. The numeric user + ID is also accepted. + role: + type: string + enum: + - reader + - writer + - admin + description: The role to grant to the collaborator. + examples: + default: + value: + actor_type: User + actor_identifier: octocat + role: writer + responses: + '201': + description: Response + content: + application/json: + schema: *324 + examples: + default: + value: + actor_type: User + role: writer + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + "/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": + put: + summary: Set a collaborator role for a Copilot Space for a user + description: |- + Updates the role of a collaborator for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-collaborator-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-a-copilot-space-for-a-user + parameters: + - *140 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (must be `User` for user-owned spaces; `Team` + will be rejected). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username of the collaborator. The numeric user ID is also + accepted. + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - role + properties: + role: + type: string + enum: + - reader + - writer + - admin + - no_access + description: The new role to grant to the collaborator. Use `no_access` + to remove the collaborator. + examples: + default: + value: + role: admin + responses: + '200': + description: Response + content: + application/json: + schema: *324 + examples: + default: + value: + actor_type: User + role: admin + login: octocat + id: 12345 + node_id: MDQ6VXNlcjEyMzQ1 + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + name: The Octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: octocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + '204': + description: Response when `role` is `no_access` and the collaborator was + removed. + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + delete: + summary: Remove a collaborator from a Copilot Space for a user + description: |- + Removes a collaborator from a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/remove-collaborator-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/collaborators#remove-a-collaborator-from-a-copilot-space-for-a-user + parameters: + - *140 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: actor_type + description: The type of actor (must be `User` for user-owned spaces; `Team` + will be rejected). + in: path + required: true + schema: + type: string + enum: + - User + - Team + - name: actor_identifier + description: The username of the collaborator. The numeric user ID is also + accepted. + in: path + required: true + schema: + type: string + responses: + '204': + description: Response + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: collaborators + "/users/{username}/copilot-spaces/{space_number}/resources": + get: + summary: List resources for a Copilot Space for a user + description: |- + Lists all resources attached to a specific Copilot Space owned by a user. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/list-resources-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/resources#list-resources-for-a-copilot-space-for-a-user + parameters: + - *140 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - resources + properties: + resources: + type: array + description: The list of resources attached to this Copilot Space. + items: *325 + examples: + default: + value: + resources: + - id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + post: + summary: Create a resource for a Copilot Space for a user + description: |- + Creates a new resource in a specific Copilot Space owned by a user. + The authenticated user must have write permissions on the space. + + The following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`. + The `uploaded_text_file` and `media_content` types are not supported via this endpoint. + + For `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status. + + OAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/create-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/resources#create-a-resource-for-a-copilot-space-for-a-user + parameters: + - *140 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - resource_type + - metadata + properties: + resource_type: + type: string + enum: + - repository + - github_file + - free_text + - github_issue + - github_pull_request + description: The type of resource to create. + metadata: + type: object + description: Resource-specific metadata. + additionalProperties: true + examples: + free_text: + value: + resource_type: free_text + metadata: + name: notes.txt + text: Some helpful notes + repository: + value: + resource_type: repository + metadata: + repository_id: 42 + github_file: + value: + resource_type: github_file + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + responses: + '201': + description: Resource created + content: + application/json: + schema: *325 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '200': + description: Duplicate github_file resource already exists + content: + application/json: + schema: *325 + examples: + default: + value: + id: 1 + resource_type: github_file + copilot_chat_attachment_id: + metadata: + repository_id: 42 + file_path: README.md + sha: abc123 + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + "/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}": + get: + summary: Get a resource for a Copilot Space for a user + description: |- + Gets a specific resource attached to a Copilot Space owned by a user. + The authenticated user must have appropriate permissions to view the space. + + OAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/get-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/resources#get-a-resource-for-a-copilot-space-for-a-user + parameters: + - *140 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *325 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: notes.txt + text: Some helpful notes + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + put: + summary: Set a resource for a Copilot Space for a user + description: |- + Updates the metadata of a resource in a specific Copilot Space owned by a user. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/update-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/resources#set-a-resource-for-a-copilot-space-for-a-user + parameters: + - *140 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + description: Updated resource-specific metadata. + additionalProperties: true + examples: + default: + value: + metadata: + name: updated-notes.txt + text: Updated content + responses: + '200': + description: Response + content: + application/json: + schema: *325 + examples: + default: + value: + id: 1 + resource_type: free_text + copilot_chat_attachment_id: + metadata: + name: updated-notes.txt + text: Updated content + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T12:00:00Z' + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources + delete: + summary: Delete a resource from a Copilot Space for a user + description: |- + Deletes a resource from a specific Copilot Space owned by a user. + The authenticated user must have write permissions on the space. + + OAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint. + tags: + - copilot-spaces + operationId: copilot-spaces/delete-resource-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot-spaces/resources#delete-a-resource-from-a-copilot-space-for-a-user + parameters: + - *140 + - name: space_number + description: The unique identifier of the Copilot Space. + in: path + required: true + schema: + type: integer + - name: space_resource_id + description: The unique identifier of the resource. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: false + category: copilot-spaces + subcategory: resources "/users/{username}/docker/conflicts": get: summary: Get list of conflicting packages during Docker migration for user @@ -126103,7 +128975,7 @@ paths: operationId: packages/list-docker-migration-conflicting-packages-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - *140 responses: @@ -126113,9 +128985,9 @@ paths: application/json: schema: type: array - items: *391 + items: *395 examples: - default: *811 + default: *815 '403': *27 '401': *23 x-github: @@ -126136,7 +129008,7 @@ paths: operationId: activity/list-events-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-events-for-the-authenticated-user parameters: - *140 - *17 @@ -126208,7 +129080,7 @@ paths: operationId: activity/list-org-events-for-authenticated-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-organization-events-for-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - *140 - *87 @@ -126296,7 +129168,7 @@ paths: operationId: activity/list-public-events-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-events-for-a-user parameters: - *140 - *17 @@ -126364,7 +129236,7 @@ paths: operationId: users/list-followers-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/followers#list-followers-of-a-user parameters: - *140 - *17 @@ -126395,7 +129267,7 @@ paths: operationId: users/list-following-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows + url: https://docs.github.com/enterprise-cloud@latest/rest/users/followers#list-the-people-a-user-follows parameters: - *140 - *17 @@ -126426,7 +129298,7 @@ paths: operationId: users/check-following-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-user-follows-another-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/followers#check-if-a-user-follows-another-user parameters: - *140 - name: target_user @@ -126453,7 +129325,7 @@ paths: operationId: gists/list-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/gists/gists#list-gists-for-a-user parameters: - *140 - *224 @@ -126487,7 +129359,7 @@ paths: operationId: users/list-gpg-keys-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#list-gpg-keys-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - *140 - *17 @@ -126499,9 +129371,9 @@ paths: application/json: schema: type: array - items: *802 + items: *806 examples: - default: *829 + default: *834 headers: Link: *45 x-github: @@ -126523,7 +129395,7 @@ paths: operationId: users/get-context-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/users#get-contextual-information-for-a-user parameters: - *140 - name: subject_type @@ -126589,13 +129461,13 @@ paths: description: |- Enables an authenticated GitHub App to find the user’s installation information. - You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + You must use a [JWT](https://docs.github.com/enterprise-cloud@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-user-installation externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-user-installation-for-the-authenticated-app + url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - *140 responses: @@ -126605,7 +129477,7 @@ paths: application/json: schema: *20 examples: - default: *366 + default: *370 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -126621,7 +129493,7 @@ paths: operationId: users/list-public-keys-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/keys#list-public-keys-for-a-user parameters: - *140 - *17 @@ -126669,15 +129541,15 @@ paths: get: summary: List organizations for a user description: |- - List [public organization memberships](https://docs.github.com/enterprise-cloud@latest//articles/publicizing-or-concealing-organization-membership) for the specified user. + List [public organization memberships](https://docs.github.com/enterprise-cloud@latest/articles/publicizing-or-concealing-organization-membership) for the specified user. - This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. + This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. tags: - orgs operationId: orgs/list-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-organizations-for-a-user parameters: - *140 - *17 @@ -126705,13 +129577,13 @@ paths: description: |- Lists all packages in a user's namespace for which the requesting user has access. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/list-packages-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-packages-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-packages-for-a-user parameters: - name: package_type description: The type of supported package. Packages in GitHub's Gradle registry @@ -126730,7 +129602,7 @@ paths: - docker - nuget - container - - *810 + - *814 - *140 - *19 - *17 @@ -126741,12 +129613,12 @@ paths: application/json: schema: type: array - items: *391 + items: *395 examples: - default: *811 + default: *815 '403': *27 '401': *23 - '400': *812 + '400': *816 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -126758,25 +129630,25 @@ paths: description: |- Gets a specific package metadata for a public package owned by a user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-for-a-user parameters: - - *393 - - *394 + - *397 + - *398 - *140 responses: '200': description: Response content: application/json: - schema: *391 + schema: *395 examples: - default: *830 + default: *835 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -126787,18 +129659,18 @@ paths: description: |- Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-a-package-for-a-user parameters: - - *393 - - *394 + - *397 + - *398 - *140 responses: '204': @@ -126821,18 +129693,18 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-a-package-for-a-user parameters: - - *393 - - *394 + - *397 + - *398 - *140 - name: token description: package token @@ -126857,16 +129729,16 @@ paths: description: |- Lists package versions for a public package owned by a specified user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-all-package-versions-for-package-owned-by-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *393 - - *394 + - *397 + - *398 - *140 responses: '200': @@ -126875,7 +129747,7 @@ paths: application/json: schema: type: array - items: *395 + items: *399 examples: default: value: @@ -126925,24 +129797,24 @@ paths: description: |- Gets a specific package version for a public package owned by a specified user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-version-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *393 - - *394 - - *396 + - *397 + - *398 + - *400 - *140 responses: '200': description: Response content: application/json: - schema: *395 + schema: *399 examples: default: value: @@ -126967,20 +129839,20 @@ paths: description: |- Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-version-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#delete-package-version-for-a-user parameters: - - *393 - - *394 + - *397 + - *398 - *140 - - *396 + - *400 responses: '204': description: Response @@ -127002,20 +129874,20 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-version-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/packages/packages#restore-package-version-for-a-user parameters: - - *393 - - *394 + - *397 + - *398 - *140 - - *396 + - *400 responses: '204': description: Response @@ -127037,7 +129909,7 @@ paths: operationId: projects/list-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-user + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/projects#list-projects-for-user parameters: - *140 - name: q @@ -127056,9 +129928,9 @@ paths: application/json: schema: type: array - items: *407 + items: *411 examples: - default: *408 + default: *412 headers: Link: *45 '304': *35 @@ -127078,18 +129950,18 @@ paths: operationId: projects/get-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-user + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/projects#get-project-for-user parameters: - - *409 + - *413 - *140 responses: '200': description: Response content: application/json: - schema: *407 + schema: *411 examples: - default: *408 + default: *412 headers: Link: *45 '304': *35 @@ -127109,9 +129981,9 @@ paths: operationId: projects/list-fields-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-user + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#list-project-fields-for-user parameters: - - *409 + - *413 - *140 - *17 - *108 @@ -127123,9 +129995,9 @@ paths: application/json: schema: type: array - items: *412 + items: *416 examples: - default: *831 + default: *836 headers: Link: *45 '304': *35 @@ -127144,10 +130016,10 @@ paths: operationId: projects/add-field-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-field-to-user-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#add-field-to-user-owned-project parameters: - *140 - - *409 + - *413 requestBody: required: true content: @@ -127185,7 +130057,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *832 + items: *837 required: - name - data_type @@ -127201,7 +130073,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *833 + iteration_configuration: *838 required: - name - data_type @@ -127223,20 +130095,20 @@ paths: value: name: Due date data_type: date - single_select_field: *834 - iteration_field: *835 + single_select_field: *839 + iteration_field: *840 responses: '201': description: Response content: application/json: - schema: *412 + schema: *416 examples: - text_field: *836 - number_field: *837 - date_field: *838 - single_select_field: *839 - iteration_field: *840 + text_field: *841 + number_field: *842 + date_field: *843 + single_select_field: *844 + iteration_field: *845 '304': *35 '403': *27 '401': *23 @@ -127255,19 +130127,19 @@ paths: operationId: projects/get-field-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#get-project-field-for-user parameters: - - *409 - - *841 + - *413 + - *846 - *140 responses: '200': description: Response content: application/json: - schema: *412 + schema: *416 examples: - default: *842 + default: *847 headers: Link: *45 '304': *35 @@ -127288,15 +130160,15 @@ paths: operationId: projects/list-items-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-a-user-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#list-items-for-a-user-owned-project parameters: - - *409 + - *413 - *140 - *108 - *109 - *17 - name: q - description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) + description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. in: query required: false @@ -127323,9 +130195,9 @@ paths: application/json: schema: type: array - items: *416 + items: *420 examples: - default: *417 + default: *421 headers: Link: *45 '304': *35 @@ -127344,10 +130216,10 @@ paths: operationId: projects/add-item-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-user-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#add-item-to-user-owned-project parameters: - *140 - - *409 + - *413 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -127417,22 +130289,22 @@ paths: description: Response content: application/json: - schema: *414 + schema: *418 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *415 + value: *419 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *415 + value: *419 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *415 + value: *419 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *415 + value: *419 '304': *35 '403': *27 '401': *23 @@ -127450,11 +130322,11 @@ paths: operationId: projects/get-user-item externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-a-user-owned-project + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *409 + - *413 - *140 - - *418 + - *422 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -127474,9 +130346,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *420 examples: - default: *417 + default: *421 headers: Link: *45 '304': *35 @@ -127495,11 +130367,11 @@ paths: operationId: projects/update-item-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-user + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#update-project-item-for-user parameters: - - *409 + - *413 - *140 - - *418 + - *422 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -127572,13 +130444,13 @@ paths: description: Response content: application/json: - schema: *416 + schema: *420 examples: - text_field: *417 - number_field: *417 - date_field: *417 - single_select_field: *417 - iteration_field: *417 + text_field: *421 + number_field: *421 + date_field: *421 + single_select_field: *421 + iteration_field: *421 '401': *23 '403': *27 '404': *6 @@ -127596,11 +130468,11 @@ paths: operationId: projects/delete-item-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-user + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#delete-project-item-for-user parameters: - - *409 + - *413 - *140 - - *418 + - *422 responses: '204': description: Response @@ -127620,11 +130492,11 @@ paths: operationId: projects/list-view-items-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-a-user-project-view + url: https://docs.github.com/enterprise-cloud@latest/rest/projects/items#list-items-for-a-user-project-view parameters: - - *409 + - *413 - *140 - - *843 + - *848 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -127650,9 +130522,9 @@ paths: application/json: schema: type: array - items: *416 + items: *420 examples: - default: *417 + default: *421 headers: Link: *45 '304': *35 @@ -127678,7 +130550,7 @@ paths: operationId: activity/list-received-events-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-received-by-the-authenticated-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - *140 - *17 @@ -127753,7 +130625,7 @@ paths: operationId: activity/list-received-public-events-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-received-by-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-events-received-by-a-user parameters: - *140 - *17 @@ -127826,7 +130698,7 @@ paths: operationId: repos/list-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repositories-for-a-user parameters: - *140 - name: type @@ -127873,7 +130745,7 @@ paths: type: array items: *278 examples: - default: *397 + default: *401 headers: Link: *45 x-github: @@ -127891,7 +130763,7 @@ paths: operationId: users/list-social-accounts-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#list-social-accounts-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - *140 - *17 @@ -127903,9 +130775,9 @@ paths: application/json: schema: type: array - items: *815 + items: *819 examples: - default: *816 + default: *820 headers: Link: *45 x-github: @@ -127923,7 +130795,7 @@ paths: operationId: users/list-ssh-signing-keys-for-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - *140 - *17 @@ -127935,9 +130807,9 @@ paths: application/json: schema: type: array - items: *817 + items: *821 examples: - default: *844 + default: *849 headers: Link: *45 x-github: @@ -127951,7 +130823,7 @@ paths: description: |- Lists repositories a user has starred. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. tags: @@ -127959,10 +130831,10 @@ paths: operationId: activity/list-repos-starred-by-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *140 - - *845 + - *850 - *110 - *17 - *19 @@ -127974,11 +130846,11 @@ paths: schema: anyOf: - type: array - items: *846 + items: *851 - type: array items: *78 examples: - default-response: *820 + default-response: *824 headers: Link: *45 x-github: @@ -127995,7 +130867,7 @@ paths: operationId: activity/list-repos-watched-by-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user + url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#list-repositories-watched-by-a-user parameters: - *140 - *17 @@ -128009,7 +130881,7 @@ paths: type: array items: *278 examples: - default: *397 + default: *401 headers: Link: *45 x-github: @@ -128026,7 +130898,7 @@ paths: operationId: meta/get-all-versions externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#get-all-api-versions + url: https://docs.github.com/enterprise-cloud@latest/rest/meta/meta#get-all-api-versions responses: '200': description: Response @@ -128060,7 +130932,7 @@ paths: operationId: meta/get-zen externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#get-the-zen-of-github + url: https://docs.github.com/enterprise-cloud@latest/rest/meta/meta#get-the-zen-of-github responses: '200': description: Response @@ -128082,14 +130954,14 @@ webhooks: post: summary: |- This event occurs when there is a change to branch protection configurations for a repository. - For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." - For information about using the APIs to manage branch protection rules, see "[Branch protection rule](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule)" in the GraphQL documentation or "[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)" in the REST API documentation. + For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." + For information about using the APIs to manage branch protection rules, see "[Branch protection rule](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule)" in the GraphQL documentation or "[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: All branch protections were disabled for a repository. operationId: branch-protection-configuration/disabled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_configuration + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_configuration parameters: - name: User-Agent in: header @@ -128138,12 +131010,12 @@ webhooks: type: string enum: - disabled - enterprise: &847 + enterprise: &852 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, - see "[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts)." + see "[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)." type: object properties: description: @@ -128207,12 +131079,12 @@ webhooks: - created_at - updated_at - avatar_url - installation: &848 + installation: &853 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App. For more information, - see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." + see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." type: object properties: id: @@ -128228,7 +131100,7 @@ webhooks: required: - id - node_id - organization: &849 + organization: &854 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -128301,7 +131173,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &850 + repository: &855 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -129171,14 +132043,14 @@ webhooks: post: summary: |- This event occurs when there is a change to branch protection configurations for a repository. - For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." - For information about using the APIs to manage branch protection rules, see "[Branch protection rule](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule)" in the GraphQL documentation or "[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)" in the REST API documentation. + For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." + For information about using the APIs to manage branch protection rules, see "[Branch protection rule](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule)" in the GraphQL documentation or "[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: All branch protections were enabled for a repository. operationId: branch-protection-configuration/enabled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_configuration + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_configuration parameters: - name: User-Agent in: header @@ -129227,10 +132099,10 @@ webhooks: type: string enum: - enabled - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -129251,13 +132123,13 @@ webhooks: branch-protection-rule-created: post: summary: |- - This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)" in the REST API documentation. + This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: A branch protection rule was created. operationId: branch-protection-rule/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_rule parameters: - name: User-Agent in: header @@ -129306,14 +132178,14 @@ webhooks: type: string enum: - created - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 - rule: &851 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + rule: &856 title: branch protection rule description: The branch protection rule. Includes a `name` and all - the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) + the [branch protection settings](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. @@ -129478,13 +132350,13 @@ webhooks: branch-protection-rule-deleted: post: summary: |- - This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)" in the REST API documentation. + This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: A branch protection rule was deleted. operationId: branch-protection-rule/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_rule parameters: - name: User-Agent in: header @@ -129533,11 +132405,11 @@ webhooks: type: string enum: - deleted - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 - rule: *851 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + rule: *856 sender: *4 required: - action @@ -129559,13 +132431,13 @@ webhooks: branch-protection-rule-edited: post: summary: |- - This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)" in the REST API documentation. + This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: A branch protection rule was edited. operationId: branch-protection-rule/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_rule parameters: - name: User-Agent in: header @@ -129725,11 +132597,11 @@ webhooks: - everyone required: - from - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 - rule: *851 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + rule: *856 sender: *4 required: - action @@ -129753,7 +132625,7 @@ webhooks: summary: |- This event occurs when there is activity related to a user's request to bypass secret scanning push protection. - For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. @@ -129761,7 +132633,7 @@ webhooks: description: A secret scanning push protection bypass request was cancelled. operationId: exemption-request-secret-scanning/cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning parameters: - name: User-Agent in: header @@ -129802,7 +132674,7 @@ webhooks: required: true content: application/json: - schema: &871 + schema: &876 title: Exemption request cancellation event type: object properties: @@ -129810,11 +132682,11 @@ webhooks: type: string enum: - cancelled - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 - exemption_request: &852 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + exemption_request: &857 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -130123,7 +132995,7 @@ webhooks: - array - 'null' description: The responses to the exemption request. - items: &853 + items: &858 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -130186,7 +133058,7 @@ webhooks: summary: |- This event occurs when there is activity related to a user's request to bypass secret scanning push protection. - For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. @@ -130194,7 +133066,7 @@ webhooks: description: A secret scanning bypass request was completed. operationId: exemption-request-secret-scanning/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning parameters: - name: User-Agent in: header @@ -130235,7 +133107,7 @@ webhooks: required: true content: application/json: - schema: &872 + schema: &877 title: Exemption request completed event type: object properties: @@ -130243,11 +133115,11 @@ webhooks: type: string enum: - completed - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 - exemption_request: *852 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + exemption_request: *857 sender: *4 required: - action @@ -130270,7 +133142,7 @@ webhooks: summary: |- This event occurs when there is activity related to a user's request to bypass secret scanning push protection. - For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. @@ -130278,7 +133150,7 @@ webhooks: description: A secret scanning push protection bypass request was created. operationId: exemption-request-secret-scanning/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning parameters: - name: User-Agent in: header @@ -130319,7 +133191,7 @@ webhooks: required: true content: application/json: - schema: &869 + schema: &874 title: Exemption request created event type: object properties: @@ -130327,11 +133199,11 @@ webhooks: type: string enum: - created - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 - exemption_request: *852 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + exemption_request: *857 sender: *4 required: - action @@ -130354,7 +133226,7 @@ webhooks: summary: |- This event occurs when there is activity related to a user's request to bypass secret scanning push protection. - For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. @@ -130362,7 +133234,7 @@ webhooks: description: A secret scanning push protection bypass response was dismissed. operationId: exemption-request-secret-scanning/response-dismissed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning parameters: - name: User-Agent in: header @@ -130403,7 +133275,7 @@ webhooks: required: true content: application/json: - schema: &873 + schema: &878 title: Exemption response dismissed event type: object properties: @@ -130411,12 +133283,12 @@ webhooks: type: string enum: - response_dismissed - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 - exemption_request: *852 - exemption_response: *853 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + exemption_request: *857 + exemption_response: *858 sender: *4 required: - action @@ -130440,7 +133312,7 @@ webhooks: summary: |- This event occurs when there is activity related to a user's request to bypass secret scanning push protection. - For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. @@ -130449,7 +133321,7 @@ webhooks: protection bypass request was submitted. operationId: exemption-request-secret-scanning/response-submitted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning parameters: - name: User-Agent in: header @@ -130490,7 +133362,7 @@ webhooks: required: true content: application/json: - schema: &870 + schema: &875 title: Exemption response submitted event type: object properties: @@ -130498,12 +133370,12 @@ webhooks: type: string enum: - response_submitted - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 - exemption_request: *852 - exemption_response: *853 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + exemption_request: *857 + exemption_response: *858 sender: *4 required: - action @@ -130525,7 +133397,7 @@ webhooks: check-run-completed: post: summary: |- - This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)" in the REST API documentation. + This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs)" in the REST API documentation. For activity relating to check suites, use the `check-suite` event. @@ -130538,7 +133410,7 @@ webhooks: description: A check run was completed, and a conclusion is available. operationId: check-run/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_run parameters: - name: User-Agent in: header @@ -130587,7 +133459,7 @@ webhooks: type: string enum: - completed - check_run: &855 + check_run: &860 title: CheckRun description: A check performed on the code of a given code change type: object @@ -130697,7 +133569,7 @@ webhooks: - examples: - neutral - deployment: *854 + deployment: *859 details_url: type: string examples: @@ -130795,10 +133667,10 @@ webhooks: - output - app - pull_requests - installation: *848 - enterprise: *847 - organization: *849 - repository: *850 + installation: *853 + enterprise: *852 + organization: *854 + repository: *855 sender: *4 required: - check_run @@ -131127,7 +133999,7 @@ webhooks: check-run-created: post: summary: |- - This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)" in the REST API documentation. + This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs)" in the REST API documentation. For activity relating to check suites, use the `check-suite` event. @@ -131140,7 +134012,7 @@ webhooks: description: A new check run was created. operationId: check-run/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_run parameters: - name: User-Agent in: header @@ -131189,11 +134061,11 @@ webhooks: type: string enum: - created - check_run: *855 - installation: *848 - enterprise: *847 - organization: *849 - repository: *850 + check_run: *860 + installation: *853 + enterprise: *852 + organization: *854 + repository: *855 sender: *4 required: - check_run @@ -131522,7 +134394,7 @@ webhooks: check-run-requested-action: post: summary: |- - This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)" in the REST API documentation. + This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs)" in the REST API documentation. For activity relating to check suites, use the `check-suite` event. @@ -131535,10 +134407,10 @@ webhooks: description: A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, - see "[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest//developers/apps/guides/creating-ci-tests-with-the-checks-api)." + see "[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest/developers/apps/guides/creating-ci-tests-with-the-checks-api)." operationId: check-run/requested-action externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_run parameters: - name: User-Agent in: header @@ -131587,11 +134459,11 @@ webhooks: type: string enum: - requested_action - check_run: *855 - installation: *848 - enterprise: *847 - organization: *849 - repository: *850 + check_run: *860 + installation: *853 + enterprise: *852 + organization: *854 + repository: *855 requested_action: description: The action requested by the user. type: object @@ -131931,7 +134803,7 @@ webhooks: check-run-rerequested: post: summary: |- - This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)" in the REST API documentation. + This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs)" in the REST API documentation. For activity relating to check suites, use the `check-suite` event. @@ -131945,7 +134817,7 @@ webhooks: someone requests to re-run the check will receive the `rerequested` payload. operationId: check-run/rerequested externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_run parameters: - name: User-Agent in: header @@ -131994,11 +134866,11 @@ webhooks: type: string enum: - rerequested - check_run: *855 - installation: *848 - enterprise: *847 - organization: *849 - repository: *850 + check_run: *860 + installation: *853 + enterprise: *852 + organization: *854 + repository: *855 sender: *4 required: - check_run @@ -132327,7 +135199,7 @@ webhooks: check-suite-completed: post: summary: |- - This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)" in the REST API documentation. + This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites)" in the REST API documentation. For activity relating to check runs, use the `check_run` event. @@ -132341,7 +135213,7 @@ webhooks: is available. operationId: check-suite/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_suite parameters: - name: User-Agent in: header @@ -132391,7 +135263,7 @@ webhooks: enum: - completed check_suite: - description: The [check_suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite). + description: The [check_suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite). type: object properties: after: @@ -132983,10 +135855,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -133008,7 +135880,7 @@ webhooks: check-suite-requested: post: summary: |- - This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)" in the REST API documentation. + This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites)" in the REST API documentation. For activity relating to check runs, use the `check_run` event. @@ -133020,12 +135892,12 @@ webhooks: > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, - see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createcheckrun) - or "[Create a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run)" + see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest/graphql/reference/mutations#createcheckrun) + or "[Create a check run](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#create-a-check-run)" in the REST API documentation. operationId: check-suite/requested externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_suite parameters: - name: User-Agent in: header @@ -133075,7 +135947,7 @@ webhooks: enum: - requested check_suite: - description: The [check_suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite). + description: The [check_suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite). type: object properties: after: @@ -133690,10 +136562,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -133715,7 +136587,7 @@ webhooks: check-suite-rerequested: post: summary: |- - This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)" in the REST API documentation. + This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites)" in the REST API documentation. For activity relating to check runs, use the `check_run` event. @@ -133727,12 +136599,12 @@ webhooks: > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check - suite](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createchecksuite) - or "[Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite)" + suite](https://docs.github.com/enterprise-cloud@latest/graphql/reference/mutations#createchecksuite) + or "[Create a check suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#create-a-check-suite)" in the REST API documentation. operationId: check-suite/rerequested externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_suite parameters: - name: User-Agent in: header @@ -133782,7 +136654,7 @@ webhooks: enum: - rerequested check_suite: - description: The [check_suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite). + description: The [check_suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite). type: object properties: after: @@ -134391,10 +137263,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -134416,7 +137288,7 @@ webhooks: code-scanning-alert-appeared-in-branch: post: summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. description: A previously created code scanning alert appeared in another branch. @@ -134424,7 +137296,7 @@ webhooks: a pre-existing code scanning alert. operationId: code-scanning-alert/appeared-in-branch externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header @@ -134563,7 +137435,7 @@ webhooks: required: - login - id - dismissed_comment: *536 + dismissed_comment: *540 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -134715,20 +137587,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &856 + commit_oid: &861 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *847 - installation: *848 - organization: *849 - ref: &857 + enterprise: *852 + installation: *853 + organization: *854 + ref: &862 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *850 + repository: *855 sender: *4 required: - action @@ -134752,13 +137624,13 @@ webhooks: code-scanning-alert-closed-by-user: post: summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. description: Someone closed a code scanning alert. operationId: code-scanning-alert/closed-by-user externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header @@ -134895,7 +137767,7 @@ webhooks: required: - login - id - dismissed_comment: *536 + dismissed_comment: *540 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -135136,12 +138008,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *856 - enterprise: *847 - installation: *848 - organization: *849 - ref: *857 - repository: *850 + commit_oid: *861 + enterprise: *852 + installation: *853 + organization: *854 + ref: *862 + repository: *855 sender: *4 required: - action @@ -135165,13 +138037,13 @@ webhooks: code-scanning-alert-created: post: summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. description: A code scanning alert was created in a repository. operationId: code-scanning-alert/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header @@ -135239,7 +138111,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *536 + dismissed_comment: *540 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -135424,12 +138296,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *856 - enterprise: *847 - installation: *848 - organization: *849 - ref: *857 - repository: *850 + commit_oid: *861 + enterprise: *852 + installation: *853 + organization: *854 + ref: *862 + repository: *855 sender: *4 required: - action @@ -135453,13 +138325,13 @@ webhooks: code-scanning-alert-fixed: post: summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. description: A code scanning alert was fixed in a branch by a commit. operationId: code-scanning-alert/fixed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header @@ -135598,7 +138470,7 @@ webhooks: required: - login - id - dismissed_comment: *536 + dismissed_comment: *540 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -135775,12 +138647,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *856 - enterprise: *847 - installation: *848 - organization: *849 - ref: *857 - repository: *850 + commit_oid: *861 + enterprise: *852 + installation: *853 + organization: *854 + ref: *862 + repository: *855 sender: *4 required: - action @@ -135804,13 +138676,13 @@ webhooks: code-scanning-alert-reopened: post: summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. description: A previously fixed code scanning alert reappeared in a branch. operationId: code-scanning-alert/reopened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header @@ -135881,7 +138753,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *536 + dismissed_comment: *540 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -136070,9 +138942,9 @@ webhooks: type: - string - 'null' - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -136080,7 +138952,7 @@ webhooks: type: - string - 'null' - repository: *850 + repository: *855 sender: *4 required: - action @@ -136104,13 +138976,13 @@ webhooks: code-scanning-alert-reopened-by-user: post: summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. description: Someone reopened a code scanning alert. operationId: code-scanning-alert/reopened-by-user externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header @@ -136179,7 +139051,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *536 + dismissed_comment: *540 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -136326,12 +139198,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *856 - enterprise: *847 - installation: *848 - organization: *849 - ref: *857 - repository: *850 + commit_oid: *861 + enterprise: *852 + installation: *853 + organization: *854 + ref: *862 + repository: *855 sender: *4 required: - action @@ -136355,13 +139227,13 @@ webhooks: code-scanning-alert-updated-assignment: post: summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest/rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. description: The assignees list of a code scanning alert has been updated. operationId: code-scanning-alert/updated-assignment externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header @@ -136500,7 +139372,7 @@ webhooks: required: - login - id - dismissed_comment: *536 + dismissed_comment: *540 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -136652,10 +139524,10 @@ webhooks: - dismissed_reason - rule - tool - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -136677,7 +139549,7 @@ webhooks: commit-comment-created: post: summary: |- - This event occurs when there is activity relating to commit comments. For more information about commit comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)." For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or "[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)" in the REST API documentation. + This event occurs when there is activity relating to commit comments. For more information about commit comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)." For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#commitcomment) or "[Commit comments](https://docs.github.com/enterprise-cloud@latest/rest/commits/comments)" in the REST API documentation. For activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event. @@ -136685,7 +139557,7 @@ webhooks: description: Someone commented on a commit. operationId: commit-comment/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#commit_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#commit_comment parameters: - name: User-Agent in: header @@ -136915,10 +139787,10 @@ webhooks: - updated_at - author_association - body - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -136949,7 +139821,7 @@ webhooks: - Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery. operationId: create externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#create + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#create parameters: - name: User-Agent in: header @@ -136999,19 +139871,19 @@ webhooks: type: - string - 'null' - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *849 - pusher_type: &858 + organization: *854 + pusher_type: &863 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &859 - description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) + ref: &864 + description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference) resource. type: string ref_type: @@ -137020,7 +139892,7 @@ webhooks: enum: - tag - branch - repository: *850 + repository: *855 sender: *4 required: - ref @@ -137047,13 +139919,13 @@ webhooks: summary: |- This event occurs when there is activity relating to a custom property. - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. description: A new custom property was created. operationId: custom-property/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header @@ -137103,9 +139975,9 @@ webhooks: enum: - created definition: *153 - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 sender: *4 required: - action @@ -137127,13 +139999,13 @@ webhooks: summary: |- This event occurs when there is activity relating to a custom property. - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. description: A custom property was deleted. operationId: custom-property/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header @@ -137190,9 +140062,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 sender: *4 required: - action @@ -137214,13 +140086,13 @@ webhooks: summary: |- This event occurs when there is activity relating to a custom property. - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. description: A custom property was promoted to an enterprise. operationId: custom-property/promote-to-enterprise externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header @@ -137270,9 +140142,9 @@ webhooks: enum: - promote_to_enterprise definition: *153 - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 sender: *4 required: - action @@ -137294,13 +140166,13 @@ webhooks: summary: |- This event occurs when there is activity relating to a custom property. - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. description: A custom property was updated. operationId: custom-property/updated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header @@ -137350,9 +140222,9 @@ webhooks: enum: - updated definition: *153 - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 sender: *4 required: - action @@ -137374,13 +140246,13 @@ webhooks: summary: |- This event occurs when there is activity relating to custom property values for a repository. - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties for a repository, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties)" in the REST API documentation. + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties for a repository, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/repos/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. description: The custom property values of a repository were updated. operationId: custom-property-values/updated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom-property-values + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom-property-values parameters: - name: User-Agent in: header @@ -137429,10 +140301,10 @@ webhooks: type: string enum: - updated - enterprise: *847 - installation: *848 - repository: *850 - organization: *849 + enterprise: *852 + installation: *853 + repository: *855 + organization: *854 sender: *4 new_property_values: type: array @@ -137472,7 +140344,7 @@ webhooks: > This event will not occur when more than three tags are deleted at once. operationId: delete externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#delete + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#delete parameters: - name: User-Agent in: header @@ -137517,18 +140389,18 @@ webhooks: title: delete event type: object properties: - enterprise: *847 - installation: *848 - organization: *849 - pusher_type: *858 - ref: *859 + enterprise: *852 + installation: *853 + organization: *854 + pusher_type: *863 + ref: *864 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *850 + repository: *855 sender: *4 required: - ref @@ -137553,13 +140425,13 @@ webhooks: summary: |- This event occurs when there is activity relating to Dependabot alerts. - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. description: The assignees for a Dependabot alert were updated. operationId: dependabot-alert/assignees-changed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -137608,11 +140480,11 @@ webhooks: type: string enum: - assignees_changed - alert: *596 - installation: *848 - organization: *849 - enterprise: *847 - repository: *850 + alert: *600 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -137636,14 +140508,14 @@ webhooks: summary: |- This event occurs when there is activity relating to Dependabot alerts. - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. description: A Dependabot alert was automatically closed by a Dependabot auto-triage rule. operationId: dependabot-alert/auto-dismissed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -137692,11 +140564,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *596 - installation: *848 - organization: *849 - enterprise: *847 - repository: *850 + alert: *600 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -137720,7 +140592,7 @@ webhooks: summary: |- This event occurs when there is activity relating to Dependabot alerts. - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. description: A Dependabot alert, that had been automatically closed by a Dependabot @@ -137728,7 +140600,7 @@ webhooks: rule changed. operationId: dependabot-alert/auto-reopened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -137777,11 +140649,11 @@ webhooks: type: string enum: - auto_reopened - alert: *596 - installation: *848 - organization: *849 - enterprise: *847 - repository: *850 + alert: *600 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -137805,7 +140677,7 @@ webhooks: summary: |- This event occurs when there is activity relating to Dependabot alerts. - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. description: A manifest file change introduced a vulnerable dependency, or a @@ -137813,7 +140685,7 @@ webhooks: to be vulnerable. operationId: dependabot-alert/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -137862,11 +140734,11 @@ webhooks: type: string enum: - created - alert: *596 - installation: *848 - organization: *849 - enterprise: *847 - repository: *850 + alert: *600 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -137890,13 +140762,13 @@ webhooks: summary: |- This event occurs when there is activity relating to Dependabot alerts. - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. description: A Dependabot alert was manually closed. operationId: dependabot-alert/dismissed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -137945,11 +140817,11 @@ webhooks: type: string enum: - dismissed - alert: *596 - installation: *848 - organization: *849 - enterprise: *847 - repository: *850 + alert: *600 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -137973,13 +140845,13 @@ webhooks: summary: |- This event occurs when there is activity relating to Dependabot alerts. - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. description: A manifest file change removed a vulnerability. operationId: dependabot-alert/fixed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -138028,11 +140900,11 @@ webhooks: type: string enum: - fixed - alert: *596 - installation: *848 - organization: *849 - enterprise: *847 - repository: *850 + alert: *600 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -138056,14 +140928,14 @@ webhooks: summary: |- This event occurs when there is activity relating to Dependabot alerts. - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. description: A manifest file change introduced a vulnerable dependency that had previously been fixed. operationId: dependabot-alert/reintroduced externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -138112,11 +140984,11 @@ webhooks: type: string enum: - reintroduced - alert: *596 - installation: *848 - organization: *849 - enterprise: *847 - repository: *850 + alert: *600 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -138140,13 +141012,13 @@ webhooks: summary: |- This event occurs when there is activity relating to Dependabot alerts. - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. description: A Dependabot alert was manually reopened. operationId: dependabot-alert/reopened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -138195,11 +141067,11 @@ webhooks: type: string enum: - reopened - alert: *596 - installation: *848 - organization: *849 - enterprise: *847 - repository: *850 + alert: *600 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -138221,13 +141093,13 @@ webhooks: deploy-key-created: post: summary: |- - This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)" in the REST API documentation. + This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. description: A deploy key was created. operationId: deploy-key/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deploy_key parameters: - name: User-Agent in: header @@ -138276,10 +141148,10 @@ webhooks: type: string enum: - created - enterprise: *847 - installation: *848 - key: &860 - description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) + enterprise: *852 + installation: *853 + key: &865 + description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object properties: @@ -138316,8 +141188,8 @@ webhooks: - verified - created_at - read_only - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 required: - action @@ -138339,13 +141211,13 @@ webhooks: deploy-key-deleted: post: summary: |- - This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)" in the REST API documentation. + This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. description: A deploy key was deleted. operationId: deploy-key/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deploy_key parameters: - name: User-Agent in: header @@ -138394,11 +141266,11 @@ webhooks: type: string enum: - deleted - enterprise: *847 - installation: *848 - key: *860 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + key: *865 + organization: *854 + repository: *855 sender: *4 required: - action @@ -138420,7 +141292,7 @@ webhooks: deployment-created: post: summary: |- - This event occurs when there is activity relating to deployments. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to deployments. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)" in the REST API documentation. For activity relating to deployment status, use the `deployment_status` event. @@ -138428,7 +141300,7 @@ webhooks: description: A deployment was created. operationId: deployment/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment parameters: - name: User-Agent in: header @@ -138479,7 +141351,7 @@ webhooks: - created deployment: title: Deployment - description: The [deployment](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments). + description: The [deployment](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#list-deployments). type: object properties: created_at: @@ -138965,12 +141837,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - workflow: &864 + workflow: &869 title: Workflow type: - object @@ -139641,13 +142513,13 @@ webhooks: deployment-protection-rule-requested: post: summary: |- - This event occurs when there is activity relating to deployment protection rules. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules)." For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments). + This event occurs when there is activity relating to deployment protection rules. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules)." For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments). To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. description: A deployment protection rule was requested for an environment. operationId: deployment-protection-rule/requested externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_protection_rule + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_protection_rule parameters: - name: User-Agent in: header @@ -139721,13 +142593,13 @@ webhooks: deployment: anyOf: - type: 'null' - - *603 + - *607 pull_requests: type: array - items: *697 - repository: *850 - organization: *849 - installation: *848 + items: *701 + repository: *855 + organization: *854 + installation: *853 sender: *4 responses: '200': @@ -139742,7 +142614,7 @@ webhooks: deployment-review-approved: post: summary: |- - This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)" in the REST API documentation. For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. @@ -139750,7 +142622,7 @@ webhooks: description: A deployment review was approved. operationId: deployment-review/approved externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_review parameters: - name: User-Agent in: header @@ -139798,7 +142670,7 @@ webhooks: type: string enum: - approved - approver: &861 + approver: &866 type: object properties: avatar_url: @@ -139841,11 +142713,11 @@ webhooks: type: string comment: type: string - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 - reviewers: &862 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + reviewers: &867 type: array items: type: object @@ -139926,7 +142798,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &863 + workflow_job_run: &868 type: object properties: conclusion: @@ -140616,7 +143488,7 @@ webhooks: deployment-review-rejected: post: summary: |- - This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)" in the REST API documentation. For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. @@ -140624,7 +143496,7 @@ webhooks: description: A deployment review was rejected. operationId: deployment-review/rejected externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_review parameters: - name: User-Agent in: header @@ -140672,18 +143544,18 @@ webhooks: type: string enum: - rejected - approver: *861 + approver: *866 comment: type: string - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 - reviewers: *862 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + reviewers: *867 sender: *4 since: type: string - workflow_job_run: *863 + workflow_job_run: *868 workflow_job_runs: type: array items: @@ -141344,7 +144216,7 @@ webhooks: deployment-review-requested: post: summary: |- - This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)" in the REST API documentation. For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. @@ -141352,7 +144224,7 @@ webhooks: description: A deployment review was requested. operationId: deployment-review/requested externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_review parameters: - name: User-Agent in: header @@ -141400,13 +144272,13 @@ webhooks: type: string enum: - requested - enterprise: *847 + enterprise: *852 environment: type: string - installation: *848 - organization: *849 - repository: *850 - requestor: &874 + installation: *853 + organization: *854 + repository: *855 + requestor: &879 title: User type: - object @@ -142232,7 +145104,7 @@ webhooks: deployment-status-created: post: summary: |- - This event occurs when there is activity relating to deployment statuses. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to deployment statuses. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)" in the REST API documentation. For activity relating to deployment creation, use the `deployment` event. @@ -142243,7 +145115,7 @@ webhooks: description: A new deployment status was created. operationId: deployment-status/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_status + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_status parameters: - name: User-Agent in: header @@ -142368,7 +145240,7 @@ webhooks: - completed_at deployment: title: Deployment - description: The [deployment](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments). + description: The [deployment](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#list-deployments). type: object properties: created_at: @@ -142859,7 +145731,7 @@ webhooks: - statuses_url - repository_url deployment_status: - description: The [deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses). + description: The [deployment status](https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#list-deployment-statuses). type: object properties: created_at: @@ -143339,12 +146211,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - workflow: *864 + workflow: *869 workflow_run: title: Deployment Workflow Run type: @@ -143975,7 +146847,7 @@ webhooks: discussion-answered: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -143986,7 +146858,7 @@ webhooks: description: A comment on the discussion was marked as the answer. operationId: discussion/answered externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -144035,7 +146907,7 @@ webhooks: type: string enum: - answered - answer: &867 + answer: &872 type: object properties: author_association: @@ -144195,11 +147067,11 @@ webhooks: - created_at - updated_at - body - discussion: *865 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -144222,7 +147094,7 @@ webhooks: discussion-category-changed: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -144233,7 +147105,7 @@ webhooks: description: The category of a discussion was changed. operationId: discussion/category-changed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -144326,11 +147198,11 @@ webhooks: - from required: - category - discussion: *865 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -144353,7 +147225,7 @@ webhooks: discussion-closed: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -144364,7 +147236,7 @@ webhooks: description: A discussion was closed. operationId: discussion/closed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -144413,11 +147285,11 @@ webhooks: type: string enum: - closed - discussion: *865 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -144439,7 +147311,7 @@ webhooks: discussion-comment-created: post: summary: |- - This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. @@ -144450,7 +147322,7 @@ webhooks: description: A comment on a discussion was created. operationId: discussion-comment/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion_comment parameters: - name: User-Agent in: header @@ -144499,7 +147371,7 @@ webhooks: type: string enum: - created - comment: &866 + comment: &871 type: object properties: author_association: @@ -144659,11 +147531,11 @@ webhooks: - updated_at - body - reactions - discussion: *865 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -144686,7 +147558,7 @@ webhooks: discussion-comment-deleted: post: summary: |- - This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. @@ -144697,7 +147569,7 @@ webhooks: description: A comment on a discussion was deleted. operationId: discussion-comment/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion_comment parameters: - name: User-Agent in: header @@ -144746,12 +147618,12 @@ webhooks: type: string enum: - deleted - comment: *866 - discussion: *865 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + comment: *871 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -144774,7 +147646,7 @@ webhooks: discussion-comment-edited: post: summary: |- - This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. @@ -144785,7 +147657,7 @@ webhooks: description: A comment on a discussion was edited. operationId: discussion-comment/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion_comment parameters: - name: User-Agent in: header @@ -144846,12 +147718,12 @@ webhooks: - from required: - body - comment: *866 - discussion: *865 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + comment: *871 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -144875,7 +147747,7 @@ webhooks: discussion-created: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -144886,7 +147758,7 @@ webhooks: description: A discussion was created. operationId: discussion/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -144935,11 +147807,11 @@ webhooks: type: string enum: - created - discussion: *865 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -144961,7 +147833,7 @@ webhooks: discussion-deleted: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -144972,7 +147844,7 @@ webhooks: description: A discussion was deleted. operationId: discussion/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -145021,11 +147893,11 @@ webhooks: type: string enum: - deleted - discussion: *865 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -145047,7 +147919,7 @@ webhooks: discussion-edited: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -145059,7 +147931,7 @@ webhooks: the discussion was changed. operationId: discussion/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -145125,11 +147997,11 @@ webhooks: type: string required: - from - discussion: *865 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -145151,7 +148023,7 @@ webhooks: discussion-labeled: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -145162,7 +148034,7 @@ webhooks: description: A label was added to a discussion. operationId: discussion/labeled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -145211,10 +148083,10 @@ webhooks: type: string enum: - labeled - discussion: *865 - enterprise: *847 - installation: *848 - label: &868 + discussion: *870 + enterprise: *852 + installation: *853 + label: &873 title: Label type: object properties: @@ -145247,8 +148119,8 @@ webhooks: - color - default - description - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 required: - action @@ -145271,7 +148143,7 @@ webhooks: discussion-locked: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -145282,7 +148154,7 @@ webhooks: description: A discussion was locked. operationId: discussion/locked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -145331,11 +148203,11 @@ webhooks: type: string enum: - locked - discussion: *865 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -145357,7 +148229,7 @@ webhooks: discussion-pinned: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -145368,7 +148240,7 @@ webhooks: description: A discussion was pinned. operationId: discussion/pinned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -145417,11 +148289,11 @@ webhooks: type: string enum: - pinned - discussion: *865 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -145443,7 +148315,7 @@ webhooks: discussion-reopened: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -145454,7 +148326,7 @@ webhooks: description: A discussion was reopened. operationId: discussion/reopened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -145503,11 +148375,11 @@ webhooks: type: string enum: - reopened - discussion: *865 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -145529,7 +148401,7 @@ webhooks: discussion-transferred: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -145540,7 +148412,7 @@ webhooks: description: A discussion was transferred to another repository. operationId: discussion/transferred externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -145592,16 +148464,16 @@ webhooks: changes: type: object properties: - new_discussion: *865 - new_repository: *850 + new_discussion: *870 + new_repository: *855 required: - new_discussion - new_repository - discussion: *865 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -145624,7 +148496,7 @@ webhooks: discussion-unanswered: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -145635,7 +148507,7 @@ webhooks: description: A comment on the discussion was unmarked as the answer. operationId: discussion/unanswered externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -145684,10 +148556,10 @@ webhooks: type: string enum: - unanswered - discussion: *865 - old_answer: *867 - organization: *849 - repository: *850 + discussion: *870 + old_answer: *872 + organization: *854 + repository: *855 sender: *4 required: - action @@ -145709,7 +148581,7 @@ webhooks: discussion-unlabeled: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -145720,7 +148592,7 @@ webhooks: description: A label was removed from a discussion. operationId: discussion/unlabeled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -145769,12 +148641,12 @@ webhooks: type: string enum: - unlabeled - discussion: *865 - enterprise: *847 - installation: *848 - label: *868 - organization: *849 - repository: *850 + discussion: *870 + enterprise: *852 + installation: *853 + label: *873 + organization: *854 + repository: *855 sender: *4 required: - action @@ -145797,7 +148669,7 @@ webhooks: discussion-unlocked: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -145808,7 +148680,7 @@ webhooks: description: A discussion was unlocked. operationId: discussion/unlocked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -145857,11 +148729,11 @@ webhooks: type: string enum: - unlocked - discussion: *865 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -145883,7 +148755,7 @@ webhooks: discussion-unpinned: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. @@ -145894,7 +148766,7 @@ webhooks: description: A discussion was unpinned. operationId: discussion/unpinned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -145943,11 +148815,11 @@ webhooks: type: string enum: - unpinned - discussion: *865 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -145975,7 +148847,7 @@ webhooks: description: A code scanning alert dismissal request was created. operationId: dismissal-request-code-scanning/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_code_scanning parameters: - name: User-Agent in: header @@ -146016,7 +148888,7 @@ webhooks: required: true content: application/json: - schema: *869 + schema: *874 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146038,7 +148910,7 @@ webhooks: description: A code scanning alert dismissal response was submitted. operationId: dismissal-request-code-scanning/response-submitted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_code_scanning parameters: - name: User-Agent in: header @@ -146079,7 +148951,7 @@ webhooks: required: true content: application/json: - schema: *870 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146101,7 +148973,7 @@ webhooks: description: A Dependabot alert dismissal request was canceled. operationId: dismissal-request-dependabot/cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_dependabot + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_dependabot parameters: - name: User-Agent in: header @@ -146142,7 +149014,7 @@ webhooks: required: true content: application/json: - schema: *871 + schema: *876 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146164,7 +149036,7 @@ webhooks: description: A Dependabot alert dismissal request was created. operationId: dismissal-request-dependabot/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_dependabot + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_dependabot parameters: - name: User-Agent in: header @@ -146205,7 +149077,7 @@ webhooks: required: true content: application/json: - schema: *869 + schema: *874 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146227,7 +149099,7 @@ webhooks: description: A Dependabot alert dismissal request received a response. operationId: dismissal-request-dependabot/response-submitted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_dependabot + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_dependabot parameters: - name: User-Agent in: header @@ -146268,7 +149140,7 @@ webhooks: required: true content: application/json: - schema: *870 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146293,7 +149165,7 @@ webhooks: description: A secret scanning alert dismissal request was canceled. operationId: dismissal-request-secret-scanning/cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: - name: User-Agent in: header @@ -146334,7 +149206,7 @@ webhooks: required: true content: application/json: - schema: *871 + schema: *876 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146359,7 +149231,7 @@ webhooks: description: A secret scanning alert dismissal request was completed. operationId: dismissal-request-secret-scanning/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: - name: User-Agent in: header @@ -146400,7 +149272,7 @@ webhooks: required: true content: application/json: - schema: *872 + schema: *877 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146425,7 +149297,7 @@ webhooks: description: A secret scanning alert dismissal request was created. operationId: dismissal-request-secret-scanning/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: - name: User-Agent in: header @@ -146466,7 +149338,7 @@ webhooks: required: true content: application/json: - schema: *869 + schema: *874 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146491,7 +149363,7 @@ webhooks: description: A secret scanning alert dismissal response was dismissed. operationId: dismissal-request-secret-scanning/response-dismissed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: - name: User-Agent in: header @@ -146532,7 +149404,7 @@ webhooks: required: true content: application/json: - schema: *873 + schema: *878 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146557,7 +149429,7 @@ webhooks: description: A secret scanning alert dismissal response was submitted. operationId: dismissal-request-secret-scanning/response-submitted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: - name: User-Agent in: header @@ -146598,7 +149470,7 @@ webhooks: required: true content: application/json: - schema: *870 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146616,13 +149488,13 @@ webhooks: summary: |- This event occurs when there is activity related to a user's request to bypass a set of push rules. - 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)." + 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. description: A push ruleset bypass request was cancelled. operationId: exemption-request-push-ruleset/cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset parameters: - name: User-Agent in: header @@ -146663,7 +149535,7 @@ webhooks: required: true content: application/json: - schema: *871 + schema: *876 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146681,13 +149553,13 @@ webhooks: summary: |- This event occurs when there is activity related to a user's request to bypass a set of push rules. - 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)." + 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. description: A push ruleset bypass request was completed. operationId: exemption-request-push-ruleset/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset parameters: - name: User-Agent in: header @@ -146728,7 +149600,7 @@ webhooks: required: true content: application/json: - schema: *872 + schema: *877 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146746,13 +149618,13 @@ webhooks: summary: |- This event occurs when there is activity related to a user's request to bypass a set of push rules. - 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)." + 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. description: A push ruleset bypass request was created. operationId: exemption-request-push-ruleset/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset parameters: - name: User-Agent in: header @@ -146793,7 +149665,7 @@ webhooks: required: true content: application/json: - schema: *869 + schema: *874 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146811,13 +149683,13 @@ webhooks: summary: |- This event occurs when there is activity related to a user's request to bypass a set of push rules. - 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)." + 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. description: A push ruleset bypass response was dismissed. operationId: exemption-request-push-ruleset/response-dismissed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset parameters: - name: User-Agent in: header @@ -146858,7 +149730,7 @@ webhooks: required: true content: application/json: - schema: *873 + schema: *878 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146876,14 +149748,14 @@ webhooks: summary: |- This event occurs when there is activity related to a user's request to bypass a set of push rules. - 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)." + 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. description: A response either approving or rejecting the push ruleset bypass request was submitted. operationId: exemption-request-push-ruleset/response-submitted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset parameters: - name: User-Agent in: header @@ -146924,7 +149796,7 @@ webhooks: required: true content: application/json: - schema: *870 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146940,12 +149812,12 @@ webhooks: fork: post: summary: |- - This event occurs when someone forks a repository. For more information, see "[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo)." For information about the API to manage forks, see "[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)" in the REST API documentation. + This event occurs when someone forks a repository. For more information, see "[Fork a repo](https://docs.github.com/enterprise-cloud@latest/get-started/quickstart/fork-a-repo)." For information about the API to manage forks, see "[Forks](https://docs.github.com/enterprise-cloud@latest/rest/repos/forks)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. operationId: fork externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#fork + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#fork parameters: - name: User-Agent in: header @@ -146991,9 +149863,9 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *847 + enterprise: *852 forkee: - description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) + description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) resource. allOf: - title: Repository @@ -147669,9 +150541,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *848 - organization: *849 - repository: *850 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - forkee @@ -147693,15 +150565,15 @@ webhooks: github-app-authorization-revoked: post: summary: |- - This event occurs when a user revokes their authorization of a GitHub App. For more information, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. + This event occurs when a user revokes their authorization of a GitHub App. For more information, see "[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)" in the REST API documentation. A GitHub App receives this webhook by default and cannot unsubscribe from this event. - Anyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." + Anyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." description: Someone revoked their authorization of a GitHub App. operationId: github-app-authorization/revoked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#github_app_authorization + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#github_app_authorization parameters: - name: User-Agent in: header @@ -147767,12 +150639,12 @@ webhooks: gollum: post: summary: |- - This event occurs when someone creates or updates a wiki page. For more information, see "[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis)." + This event occurs when someone creates or updates a wiki page. For more information, see "[About wikis](https://docs.github.com/enterprise-cloud@latest/communities/documenting-your-project-with-wikis/about-wikis)." To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. operationId: gollum externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#gollum + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#gollum parameters: - name: User-Agent in: header @@ -147817,9 +150689,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 pages: description: The pages that were updated. type: array @@ -147857,7 +150729,7 @@ webhooks: - action - sha - html_url - repository: *850 + repository: *855 sender: *4 required: - pages @@ -147880,11 +150752,11 @@ webhooks: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)" in the REST API documentation. description: Someone installed a GitHub App on a user or organization account. operationId: installation/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header @@ -147933,10 +150805,10 @@ webhooks: type: string enum: - created - enterprise: *847 + enterprise: *852 installation: *20 - organization: *849 - repositories: &875 + organization: *854 + repositories: &880 description: An array of repository objects that the installation can access. type: array @@ -147962,8 +150834,8 @@ webhooks: - name - full_name - private - repository: *850 - requester: *874 + repository: *855 + requester: *879 sender: *4 required: - action @@ -147984,12 +150856,12 @@ webhooks: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)" in the REST API documentation. description: Someone uninstalled a GitHub App from their user or organization account. operationId: installation/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header @@ -148038,11 +150910,11 @@ webhooks: type: string enum: - deleted - enterprise: *847 + enterprise: *852 installation: *20 - organization: *849 - repositories: *875 - repository: *850 + organization: *854 + repositories: *880 + repository: *855 requester: type: - 'null' @@ -148066,11 +150938,11 @@ webhooks: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)" in the REST API documentation. description: Someone granted new permissions to a GitHub App. operationId: installation/new-permissions-accepted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header @@ -148119,11 +150991,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *847 + enterprise: *852 installation: *20 - organization: *849 - repositories: *875 - repository: *850 + organization: *854 + repositories: *880 + repository: *855 requester: type: - 'null' @@ -148147,11 +151019,11 @@ webhooks: summary: |- This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)" in the REST API documentation. description: A GitHub App installation was granted access to one or more repositories. operationId: installation-repositories/added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation_repositories parameters: - name: User-Agent in: header @@ -148200,10 +151072,10 @@ webhooks: type: string enum: - added - enterprise: *847 + enterprise: *852 installation: *20 - organization: *849 - repositories_added: &876 + organization: *854 + repositories_added: &881 description: An array of repository objects, which were added to the installation. type: array @@ -148249,15 +151121,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *850 - repository_selection: &877 + repository: *855 + repository_selection: &882 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *874 + requester: *879 sender: *4 required: - action @@ -148282,12 +151154,12 @@ webhooks: summary: |- This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)" in the REST API documentation. description: Access to one or more repositories was revoked for a GitHub App installation. operationId: installation-repositories/removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation_repositories parameters: - name: User-Agent in: header @@ -148336,10 +151208,10 @@ webhooks: type: string enum: - removed - enterprise: *847 + enterprise: *852 installation: *20 - organization: *849 - repositories_added: *876 + organization: *854 + repositories_added: *881 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -148366,9 +151238,9 @@ webhooks: - name - full_name - private - repository: *850 - repository_selection: *877 - requester: *874 + repository: *855 + repository_selection: *882 + requester: *879 sender: *4 required: - action @@ -148393,12 +151265,12 @@ webhooks: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)" in the REST API documentation. description: Someone blocked access by a GitHub App to their user or organization account. operationId: installation/suspend externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header @@ -148447,11 +151319,11 @@ webhooks: type: string enum: - suspend - enterprise: *847 + enterprise: *852 installation: *20 - organization: *849 - repositories: *875 - repository: *850 + organization: *854 + repositories: *880 + repository: *855 requester: type: - 'null' @@ -148474,16 +151346,16 @@ webhooks: post: summary: This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see "[About - apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." + apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API - documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) - or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in + documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) + or "[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)" in the REST API documentation. description: Somebody renamed the user or organization account that a GitHub App is installed on. operationId: installation-target/renamed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_target + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation_target parameters: - name: User-Agent in: header @@ -148634,10 +151506,10 @@ webhooks: type: string required: - from - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 target_type: type: string @@ -148662,12 +151534,12 @@ webhooks: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)" in the REST API documentation. description: A GitHub App that was blocked from accessing a user or organization account was given access the account again. operationId: installation/unsuspend externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header @@ -148716,11 +151588,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *847 + enterprise: *852 installation: *20 - organization: *849 - repositories: *875 - repository: *850 + organization: *854 + repositories: *880 + repository: *855 requester: type: - 'null' @@ -148742,15 +151614,15 @@ webhooks: issue-comment-created: post: summary: |- - This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)" in the REST API documentation. - For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: A comment on an issue or pull request was created. operationId: issue-comment/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -148801,7 +151673,7 @@ webhooks: - created comment: title: issue comment - description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) + description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment) itself. type: object properties: @@ -148886,7 +151758,7 @@ webhooks: pin: anyOf: - type: 'null' - - *674 + - *678 user: title: User type: @@ -148972,14 +151844,14 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 issue: - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. allOf: - title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -149785,8 +152657,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *792 + issue_dependencies_summary: *793 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149803,7 +152675,7 @@ webhooks: title: description: Title of the issue type: string - type: *376 + type: *380 updated_at: type: string format: date-time @@ -150147,8 +153019,8 @@ webhooks: - state - locked - assignee - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 required: - action @@ -150171,15 +153043,15 @@ webhooks: issue-comment-deleted: post: summary: |- - This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)" in the REST API documentation. - For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: A comment on an issue or pull request was deleted. operationId: issue-comment/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -150228,9 +153100,9 @@ webhooks: type: string enum: - deleted - comment: &878 + comment: &883 title: issue comment - description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) + description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment) itself. type: object properties: @@ -150385,7 +153257,7 @@ webhooks: pin: anyOf: - type: 'null' - - *674 + - *678 required: - url - html_url @@ -150399,14 +153271,14 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 issue: - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. allOf: - title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -151208,8 +154080,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *792 + issue_dependencies_summary: *793 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151226,7 +154098,7 @@ webhooks: title: description: Title of the issue type: string - type: *376 + type: *380 updated_at: type: string format: date-time @@ -151572,8 +154444,8 @@ webhooks: - state - locked - assignee - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 required: - action @@ -151596,15 +154468,15 @@ webhooks: issue-comment-edited: post: summary: |- - This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)" in the REST API documentation. - For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: A comment on an issue or pull request was edited. operationId: issue-comment/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -151653,7 +154525,7 @@ webhooks: type: string enum: - edited - changes: &902 + changes: &907 description: The changes to the comment. type: object properties: @@ -151665,15 +154537,15 @@ webhooks: type: string required: - from - comment: *878 - enterprise: *847 - installation: *848 + comment: *883 + enterprise: *852 + installation: *853 issue: - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. allOf: - title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -152478,8 +155350,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *792 + issue_dependencies_summary: *793 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152496,7 +155368,7 @@ webhooks: title: description: Title of the issue type: string - type: *376 + type: *380 updated_at: type: string format: date-time @@ -152840,8 +155712,8 @@ webhooks: - state - locked - assignee - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 required: - action @@ -152865,15 +155737,15 @@ webhooks: issue-comment-pinned: post: summary: |- - This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)" in the REST API documentation. - For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: A comment on an issue was pinned. operationId: issue-comment/pinned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -152922,15 +155794,15 @@ webhooks: type: string enum: - pinned - comment: *878 - enterprise: *847 - installation: *848 + comment: *883 + enterprise: *852 + installation: *853 issue: - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. allOf: - title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -153737,8 +156609,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *792 + issue_dependencies_summary: *793 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153755,7 +156627,7 @@ webhooks: title: description: Title of the issue type: string - type: *376 + type: *380 updated_at: type: string format: date-time @@ -154101,8 +156973,8 @@ webhooks: - state - locked - assignee - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 required: - action @@ -154125,15 +156997,15 @@ webhooks: issue-comment-unpinned: post: summary: |- - This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)" in the REST API documentation. - For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: A comment on an issue was unpinned. operationId: issue-comment/unpinned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -154182,15 +157054,15 @@ webhooks: type: string enum: - unpinned - comment: *878 - enterprise: *847 - installation: *848 + comment: *883 + enterprise: *852 + installation: *853 issue: - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. allOf: - title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -154997,8 +157869,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *792 + issue_dependencies_summary: *793 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155015,7 +157887,7 @@ webhooks: title: description: Title of the issue type: string - type: *376 + type: *380 updated_at: type: string format: date-time @@ -155361,8 +158233,8 @@ webhooks: - state - locked - assignee - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 required: - action @@ -155393,7 +158265,7 @@ webhooks: description: An issue was marked as blocked by another issue. operationId: issue-dependencies/blocked-by-added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -155451,9 +158323,9 @@ webhooks: type: number blocking_issue: *219 blocking_issue_repo: *78 - installation: *848 - organization: *849 - repository: *850 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -155484,7 +158356,7 @@ webhooks: was removed. operationId: issue-dependencies/blocked-by-removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -155542,9 +158414,9 @@ webhooks: type: number blocking_issue: *219 blocking_issue_repo: *78 - installation: *848 - organization: *849 - repository: *850 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -155574,7 +158446,7 @@ webhooks: description: An issue was marked as blocking another issue. operationId: issue-dependencies/blocking-added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -155632,9 +158504,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *219 - installation: *848 - organization: *849 - repository: *850 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -155665,7 +158537,7 @@ webhooks: removed. operationId: issue-dependencies/blocking-removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -155723,9 +158595,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *219 - installation: *848 - organization: *849 - repository: *850 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -155747,7 +158619,7 @@ webhooks: issues-assigned: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -155755,7 +158627,7 @@ webhooks: description: An issue was assigned to a user. operationId: issues/assigned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -155805,12 +158677,12 @@ webhooks: type: string enum: - assigned - assignee: *874 - enterprise: *847 - installation: *848 - issue: &879 + assignee: *879 + enterprise: *852 + installation: *853 + issue: &884 title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -156619,11 +159491,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *792 + issue_dependencies_summary: *793 issue_field_values: type: array - items: *658 + items: *662 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156640,7 +159512,7 @@ webhooks: title: description: Title of the issue type: string - type: *376 + type: *380 updated_at: type: string format: date-time @@ -156743,8 +159615,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 required: - action @@ -156766,7 +159638,7 @@ webhooks: issues-closed: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -156774,7 +159646,7 @@ webhooks: description: An issue was closed. operationId: issues/closed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -156824,14 +159696,14 @@ webhooks: type: string enum: - closed - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 issue: - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. allOf: - title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -157641,11 +160513,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *792 + issue_dependencies_summary: *793 issue_field_values: type: array - items: *658 + items: *662 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157662,7 +160534,7 @@ webhooks: title: description: Title of the issue type: string - type: *376 + type: *380 updated_at: type: string format: date-time @@ -157908,8 +160780,8 @@ webhooks: required: - state - closed_at - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 required: - action @@ -157931,7 +160803,7 @@ webhooks: issues-deleted: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -157939,7 +160811,7 @@ webhooks: description: An issue was deleted. operationId: issues/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -157988,11 +160860,11 @@ webhooks: type: string enum: - deleted - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -158796,11 +161668,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *792 + issue_dependencies_summary: *793 issue_field_values: type: array - items: *658 + items: *662 state: description: State of the issue; either 'open' or 'closed' type: string @@ -158817,7 +161689,7 @@ webhooks: title: description: Title of the issue type: string - type: *376 + type: *380 updated_at: type: string format: date-time @@ -158919,8 +161791,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 required: - action @@ -158942,7 +161814,7 @@ webhooks: issues-demilestoned: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -158950,7 +161822,7 @@ webhooks: description: An issue was removed from a milestone. operationId: issues/demilestoned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -158999,11 +161871,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object required: @@ -159830,11 +162702,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *792 + issue_dependencies_summary: *793 issue_field_values: type: array - items: *658 + items: *662 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159851,7 +162723,7 @@ webhooks: title: description: Title of the issue type: string - type: *376 + type: *380 updated_at: type: string format: date-time @@ -159932,7 +162804,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &880 + milestone: &885 title: Milestone description: A collection of related issues and pull requests. type: object @@ -160075,8 +162947,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 required: - action @@ -160098,7 +162970,7 @@ webhooks: issues-edited: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -160106,7 +162978,7 @@ webhooks: description: The title or body on an issue was edited. operationId: issues/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -160175,11 +163047,11 @@ webhooks: type: string required: - from - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -160987,11 +163859,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *792 + issue_dependencies_summary: *793 issue_field_values: type: array - items: *658 + items: *662 state: description: State of the issue; either 'open' or 'closed' type: string @@ -161005,7 +163877,7 @@ webhooks: timeline_url: type: string format: uri - type: *376 + type: *380 title: description: Title of the issue type: string @@ -161111,9 +163983,9 @@ webhooks: - active_lock_reason - body - reactions - label: *868 - organization: *849 - repository: *850 + label: *873 + organization: *854 + repository: *855 sender: *4 required: - action @@ -161136,7 +164008,7 @@ webhooks: issues-field-added: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -161144,7 +164016,7 @@ webhooks: description: An issue field value was set or updated on an issue. operationId: issues/field-added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -161193,9 +164065,9 @@ webhooks: type: string enum: - field_added - enterprise: *847 - installation: *848 - issue: *879 + enterprise: *852 + installation: *853 + issue: *884 issue_field: type: object description: The issue field whose value was set or updated on the @@ -161314,8 +164186,8 @@ webhooks: - id required: - from - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 required: - action @@ -161338,7 +164210,7 @@ webhooks: issues-field-removed: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -161346,7 +164218,7 @@ webhooks: description: An issue field value was cleared from an issue. operationId: issues/field-removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -161395,9 +164267,9 @@ webhooks: type: string enum: - field_removed - enterprise: *847 - installation: *848 - issue: *879 + enterprise: *852 + installation: *853 + issue: *884 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -161460,8 +164332,8 @@ webhooks: - 'null' required: - id - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 required: - action @@ -161484,7 +164356,7 @@ webhooks: issues-labeled: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -161492,7 +164364,7 @@ webhooks: description: A label was added to an issue. operationId: issues/labeled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -161541,11 +164413,11 @@ webhooks: type: string enum: - labeled - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -162352,11 +165224,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *792 + issue_dependencies_summary: *793 issue_field_values: type: array - items: *658 + items: *662 state: description: State of the issue; either 'open' or 'closed' type: string @@ -162370,7 +165242,7 @@ webhooks: timeline_url: type: string format: uri - type: *376 + type: *380 title: description: Title of the issue type: string @@ -162476,9 +165348,9 @@ webhooks: - active_lock_reason - body - reactions - label: *868 - organization: *849 - repository: *850 + label: *873 + organization: *854 + repository: *855 sender: *4 required: - action @@ -162500,16 +165372,16 @@ webhooks: issues-locked: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." + "[Locking conversations](https://docs.github.com/enterprise-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations)." operationId: issues/locked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -162558,11 +165430,11 @@ webhooks: type: string enum: - locked - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object required: @@ -163394,11 +166266,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *792 + issue_dependencies_summary: *793 issue_field_values: type: array - items: *658 + items: *662 state: description: State of the issue; either 'open' or 'closed' type: string @@ -163412,7 +166284,7 @@ webhooks: timeline_url: type: string format: uri - type: *376 + type: *380 title: description: Title of the issue type: string @@ -163495,8 +166367,8 @@ webhooks: format: uri user_view_type: type: string - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 required: - action @@ -163518,7 +166390,7 @@ webhooks: issues-milestoned: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -163526,7 +166398,7 @@ webhooks: description: An issue was added to a milestone. operationId: issues/milestoned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -163575,11 +166447,11 @@ webhooks: type: string enum: - milestoned - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object required: @@ -164405,11 +167277,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *792 + issue_dependencies_summary: *793 issue_field_values: type: array - items: *658 + items: *662 state: description: State of the issue; either 'open' or 'closed' type: string @@ -164426,7 +167298,7 @@ webhooks: title: description: Title of the issue type: string - type: *376 + type: *380 updated_at: type: string format: date-time @@ -164506,9 +167378,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *880 - organization: *849 - repository: *850 + milestone: *885 + organization: *854 + repository: *855 sender: *4 required: - action @@ -164531,7 +167403,7 @@ webhooks: issues-opened: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -164540,7 +167412,7 @@ webhooks: will be `reopened` instead. operationId: issues/opened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -164594,7 +167466,7 @@ webhooks: properties: old_issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: - object @@ -165395,11 +168267,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *792 + issue_dependencies_summary: *793 issue_field_values: type: array - items: *658 + items: *662 state: description: State of the issue; either 'open' or 'closed' type: string @@ -165499,7 +168371,7 @@ webhooks: required: - login - id - type: *376 + type: *380 required: - id - number @@ -165991,11 +168863,11 @@ webhooks: required: - old_issue - old_repository - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -166799,11 +169671,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *792 + issue_dependencies_summary: *793 issue_field_values: type: array - items: *658 + items: *662 state: description: State of the issue; either 'open' or 'closed' type: string @@ -166820,7 +169692,7 @@ webhooks: title: description: Title of the issue type: string - type: *376 + type: *380 updated_at: type: string format: date-time @@ -166926,8 +169798,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 required: - action @@ -166949,16 +169821,16 @@ webhooks: issues-pinned: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: An issue was pinned to a repository. For more information, see - "[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + "[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." operationId: issues/pinned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -167007,11 +169879,11 @@ webhooks: type: string enum: - pinned - enterprise: *847 - installation: *848 - issue: &881 + enterprise: *852 + installation: *853 + issue: &886 title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -167814,11 +170686,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *792 + issue_dependencies_summary: *793 issue_field_values: type: array - items: *658 + items: *662 state: description: State of the issue; either 'open' or 'closed' type: string @@ -167835,7 +170707,7 @@ webhooks: title: description: Title of the issue type: string - type: *376 + type: *380 updated_at: type: string format: date-time @@ -167937,8 +170809,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 required: - action @@ -167960,7 +170832,7 @@ webhooks: issues-reopened: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -167968,7 +170840,7 @@ webhooks: description: A closed issue was reopened. operationId: issues/reopened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -168017,11 +170889,11 @@ webhooks: type: string enum: - reopened - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object required: @@ -168851,11 +171723,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *792 + issue_dependencies_summary: *793 issue_field_values: type: array - items: *658 + items: *662 state: description: State of the issue; either 'open' or 'closed' type: string @@ -168952,9 +171824,9 @@ webhooks: format: uri user_view_type: type: string - type: *376 - organization: *849 - repository: *850 + type: *380 + organization: *854 + repository: *855 sender: *4 required: - action @@ -168976,16 +171848,16 @@ webhooks: issues-transferred: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: An issue was transferred to another repository. For more information, - see "[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." + see "[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." operationId: issues/transferred externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -169039,7 +171911,7 @@ webhooks: properties: new_issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -169842,11 +172714,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *792 + issue_dependencies_summary: *793 issue_field_values: type: array - items: *658 + items: *662 state: description: State of the issue; either 'open' or 'closed' type: string @@ -169863,7 +172735,7 @@ webhooks: title: description: Title of the issue type: string - type: *376 + type: *380 updated_at: type: string format: date-time @@ -170456,11 +173328,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *847 - installation: *848 - issue: *881 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + issue: *886 + organization: *854 + repository: *855 sender: *4 required: - action @@ -170483,7 +173355,7 @@ webhooks: issues-typed: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -170491,7 +173363,7 @@ webhooks: description: An issue type was added to an issue. operationId: issues/typed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -170540,12 +173412,12 @@ webhooks: type: string enum: - typed - enterprise: *847 - installation: *848 - issue: *879 - type: *376 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + issue: *884 + type: *380 + organization: *854 + repository: *855 sender: *4 required: - action @@ -170568,7 +173440,7 @@ webhooks: issues-unassigned: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -170576,7 +173448,7 @@ webhooks: description: A user was unassigned from an issue. operationId: issues/unassigned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -170626,7 +173498,7 @@ webhooks: type: string enum: - unassigned - assignee: &905 + assignee: &910 title: User type: - object @@ -170698,11 +173570,11 @@ webhooks: required: - login - id - enterprise: *847 - installation: *848 - issue: *879 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + issue: *884 + organization: *854 + repository: *855 sender: *4 required: - action @@ -170724,7 +173596,7 @@ webhooks: issues-unlabeled: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -170732,7 +173604,7 @@ webhooks: description: A label was removed from an issue. operationId: issues/unlabeled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -170781,12 +173653,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *847 - installation: *848 - issue: *879 - label: *868 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + issue: *884 + label: *873 + organization: *854 + repository: *855 sender: *4 required: - action @@ -170808,16 +173680,16 @@ webhooks: issues-unlocked: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." + "[Locking conversations](https://docs.github.com/enterprise-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations)." operationId: issues/unlocked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -170866,11 +173738,11 @@ webhooks: type: string enum: - unlocked - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 issue: title: Issue - description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. type: object required: @@ -171700,11 +174572,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *792 + issue_dependencies_summary: *793 issue_field_values: type: array - items: *658 + items: *662 state: description: State of the issue; either 'open' or 'closed' type: string @@ -171721,7 +174593,7 @@ webhooks: title: description: Title of the issue type: string - type: *376 + type: *380 updated_at: type: string format: date-time @@ -171801,8 +174673,8 @@ webhooks: format: uri user_view_type: type: string - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 required: - action @@ -171824,16 +174696,16 @@ webhooks: issues-unpinned: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: An issue was unpinned from a repository. For more information, - see "[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + see "[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." operationId: issues/unpinned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -171882,11 +174754,11 @@ webhooks: type: string enum: - unpinned - enterprise: *847 - installation: *848 - issue: *881 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + issue: *886 + organization: *854 + repository: *855 sender: *4 required: - action @@ -171908,7 +174780,7 @@ webhooks: issues-untyped: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. @@ -171916,7 +174788,7 @@ webhooks: description: An issue type was removed from an issue. operationId: issues/untyped externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -171965,12 +174837,12 @@ webhooks: type: string enum: - untyped - enterprise: *847 - installation: *848 - issue: *879 - type: *376 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + issue: *884 + type: *380 + organization: *854 + repository: *855 sender: *4 required: - action @@ -171993,7 +174865,7 @@ webhooks: label-created: post: summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)" in the REST API documentation. + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels)" in the REST API documentation. If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. @@ -172001,7 +174873,7 @@ webhooks: description: A label was created. operationId: label/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -172050,11 +174922,11 @@ webhooks: type: string enum: - created - enterprise: *847 - installation: *848 - label: *868 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + label: *873 + organization: *854 + repository: *855 sender: *4 required: - action @@ -172075,7 +174947,7 @@ webhooks: label-deleted: post: summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)" in the REST API documentation. + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels)" in the REST API documentation. If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. @@ -172083,7 +174955,7 @@ webhooks: description: A label was deleted. operationId: label/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -172132,11 +175004,11 @@ webhooks: type: string enum: - deleted - enterprise: *847 - installation: *848 - label: *868 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + label: *873 + organization: *854 + repository: *855 sender: *4 required: - action @@ -172158,7 +175030,7 @@ webhooks: label-edited: post: summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)" in the REST API documentation. + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels)" in the REST API documentation. If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. @@ -172166,7 +175038,7 @@ webhooks: description: A label's name, description, or color was changed. operationId: label/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -172246,11 +175118,11 @@ webhooks: type: string required: - from - enterprise: *847 - installation: *848 - label: *868 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + label: *873 + organization: *854 + repository: *855 sender: *4 required: - action @@ -172272,16 +175144,16 @@ webhooks: marketplace-purchase-cancelled: post: summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace)." For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" + [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)" in the REST API documentation. description: Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately. operationId: marketplace-purchase/cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -172332,9 +175204,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *847 - installation: *848 - marketplace_purchase: &882 + enterprise: *852 + installation: *853 + marketplace_purchase: &887 title: Marketplace Purchase type: object required: @@ -172422,8 +175294,8 @@ webhooks: type: integer unit_count: type: integer - organization: *849 - previous_marketplace_purchase: &883 + organization: *854 + previous_marketplace_purchase: &888 title: Marketplace Purchase type: object properties: @@ -172507,7 +175379,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *850 + repository: *855 sender: *4 required: - action @@ -172527,16 +175399,16 @@ webhooks: marketplace-purchase-changed: post: summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace)." For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" + [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)" in the REST API documentation. description: Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately. operationId: marketplace-purchase/changed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -172587,10 +175459,10 @@ webhooks: - changed effective_date: type: string - enterprise: *847 - installation: *848 - marketplace_purchase: *882 - organization: *849 + enterprise: *852 + installation: *853 + marketplace_purchase: *887 + organization: *854 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -172678,7 +175550,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *850 + repository: *855 sender: *4 required: - action @@ -172698,10 +175570,10 @@ webhooks: marketplace-purchase-pending-change: post: summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace)." For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" + [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)" in the REST API documentation. description: Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing @@ -172709,7 +175581,7 @@ webhooks: be sent. operationId: marketplace-purchase/pending-change externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -172760,10 +175632,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *847 - installation: *848 - marketplace_purchase: *882 - organization: *849 + enterprise: *852 + installation: *853 + marketplace_purchase: *887 + organization: *854 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -172849,7 +175721,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *850 + repository: *855 sender: *4 required: - action @@ -172869,17 +175741,17 @@ webhooks: marketplace-purchase-pending-change-cancelled: post: summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace)." For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" + [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)" in the REST API documentation. description: Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle. operationId: marketplace-purchase/pending-change-cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -172930,8 +175802,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 marketplace_purchase: title: Marketplace Purchase type: object @@ -173017,9 +175889,9 @@ webhooks: type: integer unit_count: type: integer - organization: *849 - previous_marketplace_purchase: *883 - repository: *850 + organization: *854 + previous_marketplace_purchase: *888 + repository: *855 sender: *4 required: - action @@ -173039,16 +175911,16 @@ webhooks: marketplace-purchase-purchased: post: summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace)." For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" + [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)" in the REST API documentation. description: Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately. operationId: marketplace-purchase/purchased externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -173099,12 +175971,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *847 - installation: *848 - marketplace_purchase: *882 - organization: *849 - previous_marketplace_purchase: *883 - repository: *850 + enterprise: *852 + installation: *853 + marketplace_purchase: *887 + organization: *854 + previous_marketplace_purchase: *888 + repository: *855 sender: *4 required: - action @@ -173124,13 +175996,13 @@ webhooks: member-added: post: summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)" in the REST API documentation. + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: A GitHub user accepted an invitation to a repository. operationId: member/added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -173206,11 +176078,11 @@ webhooks: type: string required: - to - enterprise: *847 - installation: *848 - member: *874 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + member: *879 + organization: *854 + repository: *855 sender: *4 required: - action @@ -173233,13 +176105,13 @@ webhooks: member-edited: post: summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)" in the REST API documentation. + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: Permissions were changed for a collaborator on a repository. operationId: member/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -173312,11 +176184,11 @@ webhooks: type: - string - 'null' - enterprise: *847 - installation: *848 - member: *874 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + member: *879 + organization: *854 + repository: *855 sender: *4 required: - action @@ -173340,13 +176212,13 @@ webhooks: member-removed: post: summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)" in the REST API documentation. + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: A collaborator was removed from a repository. operationId: member/removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -173395,11 +176267,11 @@ webhooks: type: string enum: - removed - enterprise: *847 - installation: *848 - member: *874 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + member: *879 + organization: *854 + repository: *855 sender: *4 required: - action @@ -173422,13 +176294,13 @@ webhooks: membership-added: post: summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)" in the REST API documentation. + This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-cloud@latest/rest/teams/members)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: An organization member was added to a team. operationId: membership/added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#membership parameters: - name: User-Agent in: header @@ -173477,11 +176349,11 @@ webhooks: type: string enum: - added - enterprise: *847 - installation: *848 - member: *874 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + member: *879 + organization: *854 + repository: *855 scope: description: The scope of the membership. Currently, can only be `team`. @@ -173559,7 +176431,7 @@ webhooks: required: - login - id - team: &884 + team: &889 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -173734,13 +176606,13 @@ webhooks: membership-removed: post: summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)" in the REST API documentation. + This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-cloud@latest/rest/teams/members)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: An organization member was removed from a team. operationId: membership/removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#membership parameters: - name: User-Agent in: header @@ -173789,11 +176661,11 @@ webhooks: type: string enum: - removed - enterprise: *847 - installation: *848 - member: *874 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + member: *879 + organization: *854 + repository: *855 scope: description: The scope of the membership. Currently, can only be `team`. @@ -173872,7 +176744,7 @@ webhooks: required: - login - id - team: *884 + team: *889 required: - action - scope @@ -173895,7 +176767,7 @@ webhooks: merge-group-checks-requested: post: summary: |- - This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." + This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. description: |- @@ -173906,7 +176778,7 @@ webhooks: tags: - merge-queue externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#merge_group parameters: - name: User-Agent in: header @@ -173954,8 +176826,8 @@ webhooks: type: string enum: - checks_requested - installation: *848 - merge_group: &885 + installation: *853 + merge_group: &890 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -173974,15 +176846,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *528 + head_commit: *532 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 required: - action @@ -174000,7 +176872,7 @@ webhooks: merge-group-destroyed: post: summary: |- - This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." + This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. description: |- @@ -174011,7 +176883,7 @@ webhooks: tags: - merge-queue externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#merge_group parameters: - name: User-Agent in: header @@ -174068,10 +176940,10 @@ webhooks: - merged - invalidated - dequeued - installation: *848 - merge_group: *885 - organization: *849 - repository: *850 + installation: *853 + merge_group: *890 + organization: *854 + repository: *855 sender: *4 required: - action @@ -174095,7 +176967,7 @@ webhooks: description: The webhook was deleted. operationId: meta/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#meta + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#meta parameters: - name: User-Agent in: header @@ -174144,7 +177016,7 @@ webhooks: type: string enum: - deleted - enterprise: *847 + enterprise: *852 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -174253,12 +177125,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *848 - organization: *849 + installation: *853 + organization: *854 repository: anyOf: - type: 'null' - - *850 + - *855 sender: *4 required: - action @@ -174281,7 +177153,7 @@ webhooks: milestone-closed: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)" in the REST API documentation. If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. @@ -174289,7 +177161,7 @@ webhooks: description: A milestone was closed. operationId: milestone/closed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -174338,11 +177210,11 @@ webhooks: type: string enum: - closed - enterprise: *847 - installation: *848 - milestone: *880 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + milestone: *885 + organization: *854 + repository: *855 sender: *4 required: - action @@ -174364,7 +177236,7 @@ webhooks: milestone-created: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)" in the REST API documentation. If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. @@ -174372,7 +177244,7 @@ webhooks: description: A milestone was created. operationId: milestone/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -174421,9 +177293,9 @@ webhooks: type: string enum: - created - enterprise: *847 - installation: *848 - milestone: &886 + enterprise: *852 + installation: *853 + milestone: &891 title: Milestone description: A collection of related issues and pull requests. type: object @@ -174565,8 +177437,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 required: - action @@ -174588,7 +177460,7 @@ webhooks: milestone-deleted: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)" in the REST API documentation. If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. @@ -174596,7 +177468,7 @@ webhooks: description: A milestone was deleted. operationId: milestone/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -174645,11 +177517,11 @@ webhooks: type: string enum: - deleted - enterprise: *847 - installation: *848 - milestone: *880 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + milestone: *885 + organization: *854 + repository: *855 sender: *4 required: - action @@ -174671,7 +177543,7 @@ webhooks: milestone-edited: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)" in the REST API documentation. If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. @@ -174679,7 +177551,7 @@ webhooks: description: A milestone was edited. operationId: milestone/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -174759,11 +177631,11 @@ webhooks: type: string required: - from - enterprise: *847 - installation: *848 - milestone: *880 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + milestone: *885 + organization: *854 + repository: *855 sender: *4 required: - action @@ -174786,7 +177658,7 @@ webhooks: milestone-opened: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)" in the REST API documentation. If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. @@ -174794,7 +177666,7 @@ webhooks: description: A milestone was opened. operationId: milestone/opened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -174843,11 +177715,11 @@ webhooks: type: string enum: - opened - enterprise: *847 - installation: *848 - milestone: *886 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + milestone: *891 + organization: *854 + repository: *855 sender: *4 required: - action @@ -174869,7 +177741,7 @@ webhooks: org-block-blocked: post: summary: |- - This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)" in the REST API documentation. + This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking)" in the REST API documentation. If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. @@ -174877,7 +177749,7 @@ webhooks: description: A user was blocked from the organization. operationId: org-block/blocked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#org_block parameters: - name: User-Agent in: header @@ -174926,11 +177798,11 @@ webhooks: type: string enum: - blocked - blocked_user: *874 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + blocked_user: *879 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -174952,7 +177824,7 @@ webhooks: org-block-unblocked: post: summary: |- - This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)" in the REST API documentation. + This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking)" in the REST API documentation. If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. @@ -174960,7 +177832,7 @@ webhooks: description: A previously blocked user was unblocked from the organization. operationId: org-block/unblocked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#org_block parameters: - name: User-Agent in: header @@ -175009,11 +177881,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *874 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + blocked_user: *879 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -175039,7 +177911,7 @@ webhooks: description: A new organization custom property was created. operationId: organization-custom-property/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization_custom_property parameters: - name: User-Agent in: header @@ -175089,7 +177961,7 @@ webhooks: enum: - created definition: *148 - enterprise: *847 + enterprise: *852 sender: *4 required: - action @@ -175112,7 +177984,7 @@ webhooks: description: An organization custom property was deleted. operationId: organization-custom-property/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization_custom_property parameters: - name: User-Agent in: header @@ -175169,8 +178041,8 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 sender: *4 required: - action @@ -175193,7 +178065,7 @@ webhooks: description: An organization custom property was updated. operationId: organization-custom-property/updated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization_custom_property parameters: - name: User-Agent in: header @@ -175243,8 +178115,8 @@ webhooks: enum: - updated definition: *148 - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 sender: *4 required: - action @@ -175267,7 +178139,7 @@ webhooks: description: The custom property values of an organization were updated. operationId: organization-custom-property-values/updated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization-custom-property-values + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization-custom-property-values parameters: - name: User-Agent in: header @@ -175316,9 +178188,9 @@ webhooks: type: string enum: - updated - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 sender: *4 new_property_values: type: array @@ -175349,7 +178221,7 @@ webhooks: organization-deleted: post: summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)" in the REST API documentation. + This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)" in the REST API documentation. If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. @@ -175357,7 +178229,7 @@ webhooks: description: An organization was deleted. operationId: organization/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header @@ -175406,9 +178278,9 @@ webhooks: type: string enum: - deleted - enterprise: *847 - installation: *848 - membership: &887 + enterprise: *852 + installation: *853 + membership: &892 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -175518,8 +178390,8 @@ webhooks: - role - organization_url - user - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 required: - action @@ -175540,7 +178412,7 @@ webhooks: organization-member-added: post: summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)" in the REST API documentation. + This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)" in the REST API documentation. If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. @@ -175548,7 +178420,7 @@ webhooks: description: A member accepted an invitation to join an organization. operationId: organization/member-added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header @@ -175597,11 +178469,11 @@ webhooks: type: string enum: - member_added - enterprise: *847 - installation: *848 - membership: *887 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + membership: *892 + organization: *854 + repository: *855 sender: *4 required: - action @@ -175623,7 +178495,7 @@ webhooks: organization-member-invited: post: summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)" in the REST API documentation. + This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)" in the REST API documentation. If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. @@ -175631,7 +178503,7 @@ webhooks: description: A member was invited to join the organization. operationId: organization/member-invited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header @@ -175680,8 +178552,8 @@ webhooks: type: string enum: - member_invited - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -175803,10 +178675,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 - user: *874 + user: *879 required: - action - invitation @@ -175827,7 +178699,7 @@ webhooks: organization-member-removed: post: summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)" in the REST API documentation. + This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)" in the REST API documentation. If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. @@ -175835,7 +178707,7 @@ webhooks: description: A member was removed from the organization. operationId: organization/member-removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header @@ -175884,11 +178756,11 @@ webhooks: type: string enum: - member_removed - enterprise: *847 - installation: *848 - membership: *887 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + membership: *892 + organization: *854 + repository: *855 sender: *4 required: - action @@ -175910,7 +178782,7 @@ webhooks: organization-renamed: post: summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)" in the REST API documentation. + This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)" in the REST API documentation. If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. @@ -175918,7 +178790,7 @@ webhooks: description: The name of an organization was changed. operationId: organization/renamed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header @@ -175975,11 +178847,11 @@ webhooks: properties: from: type: string - enterprise: *847 - installation: *848 - membership: *887 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + membership: *892 + organization: *854 + repository: *855 sender: *4 required: - action @@ -176000,15 +178872,15 @@ webhooks: package-published: post: summary: This event occurs when there is activity relating to GitHub Packages. - For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages)." + For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL - API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) - or "[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)" + API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#package) + or "[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)" in the REST API documentation. description: A package was published to a registry. operationId: package/published externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#package parameters: - name: User-Agent in: header @@ -176057,9 +178929,9 @@ webhooks: type: string enum: - published - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 package: description: Information about the package. type: object @@ -176582,7 +179454,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &888 + items: &893 title: Ruby Gems metadata type: object properties: @@ -176679,7 +179551,7 @@ webhooks: - owner - package_version - registry - repository: *850 + repository: *855 sender: *4 required: - action @@ -176699,15 +179571,15 @@ webhooks: package-updated: post: summary: This event occurs when there is activity relating to GitHub Packages. - For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages)." + For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL - API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) - or "[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)" + API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#package) + or "[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)" in the REST API documentation. description: A previously published package was updated. operationId: package/updated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#package parameters: - name: User-Agent in: header @@ -176756,9 +179628,9 @@ webhooks: type: string enum: - updated - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 package: description: Information about the package. type: object @@ -177120,7 +179992,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *888 + items: *893 source_url: type: string format: uri @@ -177191,7 +180063,7 @@ webhooks: - owner - package_version - registry - repository: *850 + repository: *855 sender: *4 required: - action @@ -177212,12 +180084,12 @@ webhooks: page-build: post: summary: |- - This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see "[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-cloud@latest//pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." For information about the API to manage GitHub Pages, see "[Pages](https://docs.github.com/enterprise-cloud@latest//rest/pages)" in the REST API documentation. + This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see "[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-cloud@latest/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." For information about the API to manage GitHub Pages, see "[Pages](https://docs.github.com/enterprise-cloud@latest/rest/pages)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Pages" repository permission. operationId: page-build externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#page_build + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#page_build parameters: - name: User-Agent in: header @@ -177263,7 +180135,7 @@ webhooks: type: object properties: build: - description: The [List GitHub Pages builds](https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-github-pages-builds) + description: The [List GitHub Pages builds](https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#list-github-pages-builds) itself. type: object properties: @@ -177371,12 +180243,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *847 + enterprise: *852 id: type: integer - installation: *848 - organization: *849 - repository: *850 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - id @@ -177398,13 +180270,13 @@ webhooks: personal-access-token-request-approved: post: summary: |- - This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. description: A fine-grained personal access token request was approved. operationId: personal-access-token-request/approved externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#personal_access_token_request parameters: - name: User-Agent in: header @@ -177453,7 +180325,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &889 + personal_access_token_request: &894 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -177603,10 +180475,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *847 - organization: *849 + enterprise: *852 + organization: *854 sender: *4 - installation: *848 + installation: *853 required: - action - personal_access_token_request @@ -177627,14 +180499,14 @@ webhooks: personal-access-token-request-cancelled: post: summary: |- - This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. description: A fine-grained personal access token request was cancelled by the requester. operationId: personal-access-token-request/cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#personal_access_token_request parameters: - name: User-Agent in: header @@ -177683,11 +180555,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *889 - enterprise: *847 - organization: *849 + personal_access_token_request: *894 + enterprise: *852 + organization: *854 sender: *4 - installation: *848 + installation: *853 required: - action - personal_access_token_request @@ -177708,13 +180580,13 @@ webhooks: personal-access-token-request-created: post: summary: |- - This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. description: A fine-grained personal access token request was created. operationId: personal-access-token-request/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#personal_access_token_request parameters: - name: User-Agent in: header @@ -177763,11 +180635,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *889 - enterprise: *847 - organization: *849 + personal_access_token_request: *894 + enterprise: *852 + organization: *854 sender: *4 - installation: *848 + installation: *853 required: - action - personal_access_token_request @@ -177787,13 +180659,13 @@ webhooks: personal-access-token-request-denied: post: summary: |- - This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. description: A fine-grained personal access token request was denied. operationId: personal-access-token-request/denied externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#personal_access_token_request parameters: - name: User-Agent in: header @@ -177842,11 +180714,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *889 - organization: *849 - enterprise: *847 + personal_access_token_request: *894 + organization: *854 + enterprise: *852 sender: *4 - installation: *848 + installation: *853 required: - action - personal_access_token_request @@ -177870,7 +180742,7 @@ webhooks: a confirmation from GitHub that you configured the webhook correctly. operationId: ping externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#ping + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#ping parameters: - name: User-Agent in: header @@ -177951,7 +180823,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *890 + last_response: *895 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -177983,8 +180855,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 zen: description: Random string of GitHub zen. @@ -178158,7 +181030,7 @@ webhooks: project-card-converted: post: summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. @@ -178168,7 +181040,7 @@ webhooks: description: A note in a project (classic) was converted to an issue. operationId: project-card/converted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header @@ -178229,10 +181101,10 @@ webhooks: - from required: - note - enterprise: *847 - installation: *848 - organization: *849 - project_card: &891 + enterprise: *852 + installation: *853 + organization: *854 + project_card: &896 title: Project Card type: object properties: @@ -178355,7 +181227,7 @@ webhooks: - creator - created_at - updated_at - repository: *850 + repository: *855 sender: *4 required: - action @@ -178377,7 +181249,7 @@ webhooks: project-card-created: post: summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. @@ -178387,7 +181259,7 @@ webhooks: description: A card was added to a project (classic). operationId: project-card/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header @@ -178436,11 +181308,11 @@ webhooks: type: string enum: - created - enterprise: *847 - installation: *848 - organization: *849 - project_card: *891 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + project_card: *896 + repository: *855 sender: *4 required: - action @@ -178461,7 +181333,7 @@ webhooks: project-card-deleted: post: summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. @@ -178471,7 +181343,7 @@ webhooks: description: A card on a project (classic) was deleted. operationId: project-card/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header @@ -178520,9 +181392,9 @@ webhooks: type: string enum: - deleted - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 project_card: title: Project Card type: object @@ -178652,7 +181524,7 @@ webhooks: repository: anyOf: - type: 'null' - - *850 + - *855 sender: *4 required: - action @@ -178673,7 +181545,7 @@ webhooks: project-card-edited: post: summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. @@ -178683,7 +181555,7 @@ webhooks: description: A note on a project (classic) was edited. operationId: project-card/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header @@ -178746,11 +181618,11 @@ webhooks: - from required: - note - enterprise: *847 - installation: *848 - organization: *849 - project_card: *891 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + project_card: *896 + repository: *855 sender: *4 required: - action @@ -178772,7 +181644,7 @@ webhooks: project-card-moved: post: summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. @@ -178783,7 +181655,7 @@ webhooks: another position in its column. operationId: project-card/moved externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header @@ -178844,9 +181716,9 @@ webhooks: - from required: - column_id - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 project_card: allOf: - title: Project Card @@ -179043,7 +181915,7 @@ webhooks: type: string required: - after_id - repository: *850 + repository: *855 sender: *4 required: - action @@ -179064,7 +181936,7 @@ webhooks: project-closed: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. @@ -179074,7 +181946,7 @@ webhooks: description: A project (classic) was closed. operationId: project/closed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -179123,10 +181995,10 @@ webhooks: type: string enum: - closed - enterprise: *847 - installation: *848 - organization: *849 - project: &893 + enterprise: *852 + installation: *853 + organization: *854 + project: &898 title: Project type: object properties: @@ -179253,7 +182125,7 @@ webhooks: - creator - created_at - updated_at - repository: *850 + repository: *855 sender: *4 required: - action @@ -179274,7 +182146,7 @@ webhooks: project-column-created: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. @@ -179284,7 +182156,7 @@ webhooks: description: A column was added to a project (classic). operationId: project-column/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header @@ -179333,10 +182205,10 @@ webhooks: type: string enum: - created - enterprise: *847 - installation: *848 - organization: *849 - project_column: &892 + enterprise: *852 + installation: *853 + organization: *854 + project_column: &897 title: Project Column type: object properties: @@ -179376,7 +182248,7 @@ webhooks: - name - created_at - updated_at - repository: *850 + repository: *855 sender: *4 required: - action @@ -179396,7 +182268,7 @@ webhooks: project-column-deleted: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. @@ -179406,7 +182278,7 @@ webhooks: description: A column was deleted from a project (classic). operationId: project-column/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header @@ -179455,14 +182327,14 @@ webhooks: type: string enum: - deleted - enterprise: *847 - installation: *848 - organization: *849 - project_column: *892 + enterprise: *852 + installation: *853 + organization: *854 + project_column: *897 repository: anyOf: - type: 'null' - - *850 + - *855 sender: *4 required: - action @@ -179482,7 +182354,7 @@ webhooks: project-column-edited: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. @@ -179492,7 +182364,7 @@ webhooks: description: The name of a column on a project (classic) was changed. operationId: project-column/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header @@ -179551,11 +182423,11 @@ webhooks: type: string required: - from - enterprise: *847 - installation: *848 - organization: *849 - project_column: *892 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + project_column: *897 + repository: *855 sender: *4 required: - action @@ -179576,7 +182448,7 @@ webhooks: project-column-moved: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. @@ -179586,7 +182458,7 @@ webhooks: description: A column was moved to a new position on a project (classic). operationId: project-column/moved externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header @@ -179635,11 +182507,11 @@ webhooks: type: string enum: - moved - enterprise: *847 - installation: *848 - organization: *849 - project_column: *892 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + project_column: *897 + repository: *855 sender: *4 required: - action @@ -179660,7 +182532,7 @@ webhooks: project-created: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. @@ -179670,7 +182542,7 @@ webhooks: description: A project (classic) was created. operationId: project/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -179719,11 +182591,11 @@ webhooks: type: string enum: - created - enterprise: *847 - installation: *848 - organization: *849 - project: *893 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + project: *898 + repository: *855 sender: *4 required: - action @@ -179744,7 +182616,7 @@ webhooks: project-deleted: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. @@ -179754,7 +182626,7 @@ webhooks: description: A project (classic) was deleted. operationId: project/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -179803,14 +182675,14 @@ webhooks: type: string enum: - deleted - enterprise: *847 - installation: *848 - organization: *849 - project: *893 + enterprise: *852 + installation: *853 + organization: *854 + project: *898 repository: anyOf: - type: 'null' - - *850 + - *855 sender: *4 required: - action @@ -179830,7 +182702,7 @@ webhooks: project-edited: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. @@ -179840,7 +182712,7 @@ webhooks: description: The name or description of a project (classic) was changed. operationId: project/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -179911,11 +182783,11 @@ webhooks: type: string required: - from - enterprise: *847 - installation: *848 - organization: *849 - project: *893 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + project: *898 + repository: *855 sender: *4 required: - action @@ -179935,7 +182807,7 @@ webhooks: project-reopened: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)" in the REST API documentation. For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. @@ -179945,7 +182817,7 @@ webhooks: description: A project (classic) was closed. operationId: project/reopened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -179994,11 +182866,11 @@ webhooks: type: string enum: - reopened - enterprise: *847 - installation: *848 - organization: *849 - project: *893 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + project: *898 + repository: *855 sender: *4 required: - action @@ -180019,7 +182891,7 @@ webhooks: projects-v2-closed: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2). For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -180030,7 +182902,7 @@ webhooks: description: A project in the organization was closed. operationId: projects-v2/closed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -180079,9 +182951,9 @@ webhooks: type: string enum: - closed - installation: *848 - organization: *849 - projects_v2: *407 + installation: *853 + organization: *854 + projects_v2: *411 sender: *4 required: - action @@ -180102,7 +182974,7 @@ webhooks: projects-v2-created: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2). For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -180113,7 +182985,7 @@ webhooks: description: A project in the organization was created. operationId: projects-v2/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -180162,9 +183034,9 @@ webhooks: type: string enum: - created - installation: *848 - organization: *849 - projects_v2: *407 + installation: *853 + organization: *854 + projects_v2: *411 sender: *4 required: - action @@ -180185,7 +183057,7 @@ webhooks: projects-v2-deleted: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2). For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -180196,7 +183068,7 @@ webhooks: description: A project in the organization was deleted. operationId: projects-v2/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -180245,9 +183117,9 @@ webhooks: type: string enum: - deleted - installation: *848 - organization: *849 - projects_v2: *407 + installation: *853 + organization: *854 + projects_v2: *411 sender: *4 required: - action @@ -180268,7 +183140,7 @@ webhooks: projects-v2-edited: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2). For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -180280,7 +183152,7 @@ webhooks: was changed. operationId: projects-v2/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -180368,9 +183240,9 @@ webhooks: type: string to: type: string - installation: *848 - organization: *849 - projects_v2: *407 + installation: *853 + organization: *854 + projects_v2: *411 sender: *4 required: - action @@ -180392,7 +183264,7 @@ webhooks: projects-v2-item-archived: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -180401,10 +183273,10 @@ webhooks: > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: An item on an organization project was archived. For more information, - see "[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." + see "[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." operationId: projects-v2-item/archived externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -180453,7 +183325,7 @@ webhooks: type: string enum: - archived - changes: &897 + changes: &902 type: object properties: archived_at: @@ -180469,9 +183341,9 @@ webhooks: - string - 'null' format: date-time - installation: *848 - organization: *849 - projects_v2_item: &894 + installation: *853 + organization: *854 + projects_v2_item: &899 title: Projects v2 Item description: An item belonging to a project type: object @@ -180489,7 +183361,7 @@ webhooks: type: string description: The node ID of the content represented by this item. - content_type: *413 + content_type: *417 creator: *4 created_at: type: string @@ -180539,7 +183411,7 @@ webhooks: projects-v2-item-converted: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -180550,7 +183422,7 @@ webhooks: description: A draft issue in an organization project was converted to an issue. operationId: projects-v2-item/converted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -180611,9 +183483,9 @@ webhooks: - 'null' to: type: string - installation: *848 - organization: *849 - projects_v2_item: *894 + installation: *853 + organization: *854 + projects_v2_item: *899 sender: *4 required: - action @@ -180635,7 +183507,7 @@ webhooks: projects-v2-item-created: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -180646,7 +183518,7 @@ webhooks: description: An item was added to a project in the organization. operationId: projects-v2-item/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -180695,9 +183567,9 @@ webhooks: type: string enum: - created - installation: *848 - organization: *849 - projects_v2_item: *894 + installation: *853 + organization: *854 + projects_v2_item: *899 sender: *4 required: - action @@ -180718,7 +183590,7 @@ webhooks: projects-v2-item-deleted: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -180729,7 +183601,7 @@ webhooks: description: An item was deleted from a project in the organization. operationId: projects-v2-item/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -180778,9 +183650,9 @@ webhooks: type: string enum: - deleted - installation: *848 - organization: *849 - projects_v2_item: *894 + installation: *853 + organization: *854 + projects_v2_item: *899 sender: *4 required: - action @@ -180801,7 +183673,7 @@ webhooks: projects-v2-item-edited: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -180814,7 +183686,7 @@ webhooks: issue was changed, or a draft issue was converted to an issue. operationId: projects-v2-item/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -180885,7 +183757,7 @@ webhooks: oneOf: - type: string - type: integer - - &895 + - &900 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -180909,7 +183781,7 @@ webhooks: required: - id - name - - &896 + - &901 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -180949,8 +183821,8 @@ webhooks: oneOf: - type: string - type: integer - - *895 - - *896 + - *900 + - *901 type: - 'null' - string @@ -180973,9 +183845,9 @@ webhooks: - 'null' required: - body - installation: *848 - organization: *849 - projects_v2_item: *894 + installation: *853 + organization: *854 + projects_v2_item: *899 sender: *4 required: - action @@ -180996,7 +183868,7 @@ webhooks: projects-v2-item-reordered: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -181009,7 +183881,7 @@ webhooks: board layout. operationId: projects-v2-item/reordered externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -181072,9 +183944,9 @@ webhooks: type: - string - 'null' - installation: *848 - organization: *849 - projects_v2_item: *894 + installation: *853 + organization: *854 + projects_v2_item: *899 sender: *4 required: - action @@ -181096,7 +183968,7 @@ webhooks: projects-v2-item-restored: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -181105,10 +183977,10 @@ webhooks: > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: An archived item on an organization project was restored from the - archive. For more information, see "[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." + archive. For more information, see "[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." operationId: projects-v2-item/restored externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -181157,10 +184029,10 @@ webhooks: type: string enum: - restored - changes: *897 - installation: *848 - organization: *849 - projects_v2_item: *894 + changes: *902 + installation: *853 + organization: *854 + projects_v2_item: *899 sender: *4 required: - action @@ -181182,7 +184054,7 @@ webhooks: projects-v2-reopened: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#projectv2). For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. @@ -181193,7 +184065,7 @@ webhooks: description: A project in the organization was reopened. operationId: projects-v2/reopened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -181242,9 +184114,9 @@ webhooks: type: string enum: - reopened - installation: *848 - organization: *849 - projects_v2: *407 + installation: *853 + organization: *854 + projects_v2: *411 sender: *4 required: - action @@ -181265,7 +184137,7 @@ webhooks: projects-v2-status-update-created: post: summary: |- - This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For activity relating to a project, use the `projects_v2` event. @@ -181276,7 +184148,7 @@ webhooks: description: A status update was added to a project in the organization. operationId: projects-v2-status-update/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header @@ -181325,9 +184197,9 @@ webhooks: type: string enum: - created - installation: *848 - organization: *849 - projects_v2_status_update: *898 + installation: *853 + organization: *854 + projects_v2_status_update: *903 sender: *4 required: - action @@ -181348,7 +184220,7 @@ webhooks: projects-v2-status-update-deleted: post: summary: |- - This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For activity relating to a project, use the `projects_v2` event. @@ -181359,7 +184231,7 @@ webhooks: description: A status update was removed from a project in the organization. operationId: projects-v2-status-update/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header @@ -181408,9 +184280,9 @@ webhooks: type: string enum: - deleted - installation: *848 - organization: *849 - projects_v2_status_update: *898 + installation: *853 + organization: *854 + projects_v2_status_update: *903 sender: *4 required: - action @@ -181431,7 +184303,7 @@ webhooks: projects-v2-status-update-edited: post: summary: |- - This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For activity relating to a project, use the `projects_v2` event. @@ -181442,7 +184314,7 @@ webhooks: description: A status update was edited on a project in the organization. operationId: projects-v2-status-update/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header @@ -181556,9 +184428,9 @@ webhooks: - string - 'null' format: date - installation: *848 - organization: *849 - projects_v2_status_update: *898 + installation: *853 + organization: *854 + projects_v2_status_update: *903 sender: *4 required: - action @@ -181579,12 +184451,12 @@ webhooks: public: post: summary: |- - This event occurs when repository visibility changes from private to public. For more information, see "[Setting repository visibility](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." + This event occurs when repository visibility changes from private to public. For more information, see "[Setting repository visibility](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. operationId: public externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#public + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#public parameters: - name: User-Agent in: header @@ -181629,10 +184501,10 @@ webhooks: title: public event type: object properties: - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - repository @@ -181652,7 +184524,7 @@ webhooks: pull-request-assigned: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -181660,7 +184532,7 @@ webhooks: description: A pull request was assigned to a user. operationId: pull-request/assigned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -181709,13 +184581,13 @@ webhooks: type: string enum: - assigned - assignee: *874 - enterprise: *847 - installation: *848 - number: &899 + assignee: *879 + enterprise: *852 + installation: *853 + number: &904 description: The pull request number. type: integer - organization: *849 + organization: *854 pull_request: title: Pull Request type: object @@ -184086,7 +186958,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *850 + repository: *855 sender: *4 required: - action @@ -184110,16 +186982,16 @@ webhooks: pull-request-auto-merge-disabled: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: Auto merge was disabled for a pull request. For more information, - see "[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." + see "[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." operationId: pull-request/auto-merge-disabled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -184168,11 +187040,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 number: type: integer - organization: *849 + organization: *854 pull_request: title: Pull Request type: object @@ -186536,7 +189408,7 @@ webhooks: - draft reason: type: string - repository: *850 + repository: *855 sender: *4 required: - action @@ -186560,16 +189432,16 @@ webhooks: pull-request-auto-merge-enabled: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: Auto merge was enabled for a pull request. For more information, - see "[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." + see "[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." operationId: pull-request/auto-merge-enabled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -186618,11 +189490,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 number: type: integer - organization: *849 + organization: *854 pull_request: title: Pull Request type: object @@ -188986,7 +191858,7 @@ webhooks: - draft reason: type: string - repository: *850 + repository: *855 sender: *4 required: - action @@ -189009,7 +191881,7 @@ webhooks: pull-request-closed: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -189019,7 +191891,7 @@ webhooks: true in the webhook payload, the pull request was merged. operationId: pull-request/closed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -189068,13 +191940,13 @@ webhooks: type: string enum: - closed - enterprise: *847 - installation: *848 - number: *899 - organization: *849 - pull_request: &900 + enterprise: *852 + installation: *853 + number: *904 + organization: *854 + pull_request: &905 allOf: - - *697 + - *701 - type: object properties: allow_auto_merge: @@ -189136,7 +192008,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *850 + repository: *855 sender: *4 required: - action @@ -189159,16 +192031,16 @@ webhooks: pull-request-converted-to-draft: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A pull request was converted to a draft. For more information, - see "[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." + see "[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." operationId: pull-request/converted-to-draft externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -189217,12 +192089,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *847 - installation: *848 - number: *899 - organization: *849 - pull_request: *900 - repository: *850 + enterprise: *852 + installation: *853 + number: *904 + organization: *854 + pull_request: *905 + repository: *855 sender: *4 required: - action @@ -189245,7 +192117,7 @@ webhooks: pull-request-demilestoned: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -189253,7 +192125,7 @@ webhooks: description: A pull request was removed from a milestone. operationId: pull-request/demilestoned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -189302,11 +192174,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *847 - milestone: *410 - number: *899 - organization: *849 - pull_request: &901 + enterprise: *852 + milestone: *414 + number: *904 + organization: *854 + pull_request: &906 title: Pull Request type: object properties: @@ -191655,7 +194527,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *850 + repository: *855 sender: *4 required: - action @@ -191677,7 +194549,7 @@ webhooks: pull-request-dequeued: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -191685,7 +194557,7 @@ webhooks: description: A pull request was removed from the merge queue. operationId: pull-request/dequeued externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -191734,11 +194606,11 @@ webhooks: type: string enum: - dequeued - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 number: type: integer - organization: *849 + organization: *854 pull_request: title: Pull Request type: object @@ -194106,7 +196978,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *850 + repository: *855 sender: *4 required: - action @@ -194130,7 +197002,7 @@ webhooks: pull-request-edited: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -194139,7 +197011,7 @@ webhooks: of a pull request was changed. operationId: pull-request/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -194230,12 +197102,12 @@ webhooks: type: string required: - from - enterprise: *847 - installation: *848 - number: *899 - organization: *849 - pull_request: *900 - repository: *850 + enterprise: *852 + installation: *853 + number: *904 + organization: *854 + pull_request: *905 + repository: *855 sender: *4 required: - action @@ -194258,7 +197130,7 @@ webhooks: pull-request-enqueued: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -194266,7 +197138,7 @@ webhooks: description: A pull request was added to the merge queue. operationId: pull-request/enqueued externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -194315,11 +197187,11 @@ webhooks: type: string enum: - enqueued - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 number: type: integer - organization: *849 + organization: *854 pull_request: title: Pull Request type: object @@ -196672,7 +199544,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *850 + repository: *855 sender: *4 required: - action @@ -196695,7 +199567,7 @@ webhooks: pull-request-labeled: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -196703,7 +199575,7 @@ webhooks: description: A label was added to a pull request. operationId: pull-request/labeled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -196752,11 +199624,11 @@ webhooks: type: string enum: - labeled - enterprise: *847 - installation: *848 - label: *868 - number: *899 - organization: *849 + enterprise: *852 + installation: *853 + label: *873 + number: *904 + organization: *854 pull_request: title: Pull Request type: object @@ -199126,7 +201998,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *850 + repository: *855 sender: *4 required: - action @@ -199149,16 +202021,16 @@ webhooks: pull-request-locked: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: Conversation on a pull request was locked. For more information, - see "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." + see "[Locking conversations](https://docs.github.com/enterprise-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations)." operationId: pull-request/locked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -199207,10 +202079,10 @@ webhooks: type: string enum: - locked - enterprise: *847 - installation: *848 - number: *899 - organization: *849 + enterprise: *852 + installation: *853 + number: *904 + organization: *854 pull_request: title: Pull Request type: object @@ -201578,7 +204450,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *850 + repository: *855 sender: *4 required: - action @@ -201601,7 +204473,7 @@ webhooks: pull-request-milestoned: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -201609,7 +204481,7 @@ webhooks: description: A pull request was added to a milestone. operationId: pull-request/milestoned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -201658,12 +204530,12 @@ webhooks: type: string enum: - milestoned - enterprise: *847 - milestone: *410 - number: *899 - organization: *849 - pull_request: *901 - repository: *850 + enterprise: *852 + milestone: *414 + number: *904 + organization: *854 + pull_request: *906 + repository: *855 sender: *4 required: - action @@ -201685,7 +204557,7 @@ webhooks: pull-request-opened: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -201693,7 +204565,7 @@ webhooks: description: A pull request was created operationId: pull-request/opened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -201742,12 +204614,12 @@ webhooks: type: string enum: - opened - enterprise: *847 - installation: *848 - number: *899 - organization: *849 - pull_request: *900 - repository: *850 + enterprise: *852 + installation: *853 + number: *904 + organization: *854 + pull_request: *905 + repository: *855 sender: *4 required: - action @@ -201770,16 +204642,16 @@ webhooks: pull-request-ready-for-review: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A draft pull request was marked as ready for review. For more information, - see "[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." + see "[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." operationId: pull-request/ready-for-review externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -201828,12 +204700,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *847 - installation: *848 - number: *899 - organization: *849 - pull_request: *900 - repository: *850 + enterprise: *852 + installation: *853 + number: *904 + organization: *854 + pull_request: *905 + repository: *855 sender: *4 required: - action @@ -201856,7 +204728,7 @@ webhooks: pull-request-reopened: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -201864,7 +204736,7 @@ webhooks: description: A previously closed pull request was reopened. operationId: pull-request/reopened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -201913,12 +204785,12 @@ webhooks: type: string enum: - reopened - enterprise: *847 - installation: *848 - number: *899 - organization: *849 - pull_request: *900 - repository: *850 + enterprise: *852 + installation: *853 + number: *904 + organization: *854 + pull_request: *905 + repository: *855 sender: *4 required: - action @@ -201941,7 +204813,7 @@ webhooks: pull-request-review-comment-created: post: summary: |- - This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)" in the REST API documentation. For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -201949,7 +204821,7 @@ webhooks: description: A comment on a pull request diff was created. operationId: pull-request-review-comment/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header @@ -202000,7 +204872,7 @@ webhooks: - created comment: title: Pull Request Review Comment - description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) + description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: @@ -202293,9 +205165,9 @@ webhooks: - start_side - side - reactions - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 pull_request: type: object properties: @@ -204547,7 +207419,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *850 + repository: *855 sender: *4 required: - action @@ -204570,7 +207442,7 @@ webhooks: pull-request-review-comment-deleted: post: summary: |- - This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)" in the REST API documentation. For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -204578,7 +207450,7 @@ webhooks: description: A comment on a pull request diff was deleted. operationId: pull-request-review-comment/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header @@ -204627,9 +207499,9 @@ webhooks: type: string enum: - deleted - comment: &903 + comment: &908 title: Pull Request Review Comment - description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) + description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: @@ -204920,9 +207792,9 @@ webhooks: - start_side - side - reactions - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 pull_request: type: object properties: @@ -207162,7 +210034,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *850 + repository: *855 sender: *4 required: - action @@ -207185,7 +210057,7 @@ webhooks: pull-request-review-comment-edited: post: summary: |- - This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)" in the REST API documentation. For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -207193,7 +210065,7 @@ webhooks: description: The content of a comment on a pull request diff was changed. operationId: pull-request-review-comment/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header @@ -207242,11 +210114,11 @@ webhooks: type: string enum: - edited - changes: *902 - comment: *903 - enterprise: *847 - installation: *848 - organization: *849 + changes: *907 + comment: *908 + enterprise: *852 + installation: *853 + organization: *854 pull_request: type: object properties: @@ -209489,7 +212361,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *850 + repository: *855 sender: *4 required: - action @@ -209513,7 +212385,7 @@ webhooks: pull-request-review-dismissed: post: summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -209521,7 +212393,7 @@ webhooks: description: A review on a pull request was dismissed. operationId: pull-request-review/dismissed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header @@ -209570,9 +212442,9 @@ webhooks: type: string enum: - dismissed - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 pull_request: title: Simple Pull Request type: object @@ -211827,7 +214699,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *850 + repository: *855 review: description: The review that was affected. type: object @@ -212009,7 +214881,7 @@ webhooks: pull-request-review-edited: post: summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -212017,7 +214889,7 @@ webhooks: description: The body comment on a pull request review was edited. operationId: pull-request-review/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header @@ -212078,9 +214950,9 @@ webhooks: type: string required: - from - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 pull_request: title: Simple Pull Request type: object @@ -214194,8 +217066,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *850 - review: &904 + repository: *855 + review: &909 description: The review that was affected. type: object properties: @@ -214374,7 +217246,7 @@ webhooks: pull-request-review-request-removed: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -214383,7 +217255,7 @@ webhooks: request. operationId: pull-request/review-request-removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -214433,12 +217305,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 number: description: The pull request number. type: integer - organization: *849 + organization: *854 pull_request: title: Pull Request type: object @@ -216807,7 +219679,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *850 + repository: *855 requested_reviewer: title: User type: @@ -216893,12 +219765,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 number: description: The pull request number. type: integer - organization: *849 + organization: *854 pull_request: title: Pull Request type: object @@ -219274,7 +222146,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *850 + repository: *855 requested_team: title: Team description: Groups of organization members that gives permissions @@ -219410,16 +222282,16 @@ webhooks: pull-request-review-requested: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: Review by a person or team was requested for a pull request. For - more information, see "[Requesting a pull request review](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." + more information, see "[Requesting a pull request review](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." operationId: pull-request/review-requested externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -219469,12 +222341,12 @@ webhooks: type: string enum: - review_requested - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 number: description: The pull request number. type: integer - organization: *849 + organization: *854 pull_request: title: Pull Request type: object @@ -221845,7 +224717,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *850 + repository: *855 requested_reviewer: title: User type: @@ -221932,12 +224804,12 @@ webhooks: type: string enum: - review_requested - enterprise: *847 - installation: *848 + enterprise: *852 + installation: *853 number: description: The pull request number. type: integer - organization: *849 + organization: *854 pull_request: title: Pull Request type: object @@ -224299,7 +227171,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *850 + repository: *855 requested_team: title: Team description: Groups of organization members that gives permissions @@ -224426,7 +227298,7 @@ webhooks: pull-request-review-submitted: post: summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -224434,7 +227306,7 @@ webhooks: description: A review on a pull request was submitted. operationId: pull-request-review/submitted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header @@ -224483,9 +227355,9 @@ webhooks: type: string enum: - submitted - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 pull_request: title: Simple Pull Request type: object @@ -226743,8 +229615,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *850 - review: *904 + repository: *855 + review: *909 sender: *4 required: - action @@ -226767,7 +229639,7 @@ webhooks: pull-request-review-thread-resolved: post: summary: |- - This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. @@ -226775,7 +229647,7 @@ webhooks: description: A comment thread on a pull request was marked as resolved. operationId: pull-request-review-thread/resolved externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: - name: User-Agent in: header @@ -226824,9 +229696,9 @@ webhooks: type: string enum: - resolved - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 pull_request: title: Simple Pull Request type: object @@ -228979,7 +231851,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *850 + repository: *855 sender: *4 thread: type: object @@ -228988,7 +231860,7 @@ webhooks: type: array items: title: Pull Request Review Comment - description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) + description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: @@ -229318,7 +232190,7 @@ webhooks: pull-request-review-thread-unresolved: post: summary: |- - This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. @@ -229327,7 +232199,7 @@ webhooks: as unresolved. operationId: pull-request-review-thread/unresolved externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: - name: User-Agent in: header @@ -229376,9 +232248,9 @@ webhooks: type: string enum: - unresolved - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 pull_request: title: Simple Pull Request type: object @@ -231514,7 +234386,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *850 + repository: *855 sender: *4 thread: type: object @@ -231523,7 +234395,7 @@ webhooks: type: array items: title: Pull Request Review Comment - description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) + description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: @@ -231850,7 +234722,7 @@ webhooks: pull-request-synchronize: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -231860,7 +234732,7 @@ webhooks: head branch. operationId: pull-request/synchronize externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -231913,10 +234785,10 @@ webhooks: type: string before: type: string - enterprise: *847 - installation: *848 - number: *899 - organization: *849 + enterprise: *852 + installation: *853 + number: *904 + organization: *854 pull_request: title: Pull Request type: object @@ -234273,7 +237145,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *850 + repository: *855 sender: *4 required: - action @@ -234298,7 +237170,7 @@ webhooks: pull-request-unassigned: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -234306,7 +237178,7 @@ webhooks: description: A user was unassigned from a pull request. operationId: pull-request/unassigned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -234355,11 +237227,11 @@ webhooks: type: string enum: - unassigned - assignee: *905 - enterprise: *847 - installation: *848 - number: *899 - organization: *849 + assignee: *910 + enterprise: *852 + installation: *853 + number: *904 + organization: *854 pull_request: title: Pull Request type: object @@ -236731,7 +239603,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *850 + repository: *855 sender: *4 required: - action @@ -236753,7 +239625,7 @@ webhooks: pull-request-unlabeled: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. @@ -236761,7 +239633,7 @@ webhooks: description: A label was removed from a pull request. operationId: pull-request/unlabeled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -236810,11 +239682,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *847 - installation: *848 - label: *868 - number: *899 - organization: *849 + enterprise: *852 + installation: *853 + label: *873 + number: *904 + organization: *854 pull_request: title: Pull Request type: object @@ -239175,7 +242047,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *850 + repository: *855 sender: *4 required: - action @@ -239198,16 +242070,16 @@ webhooks: pull-request-unlocked: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: Conversation on a pull request was unlocked. For more information, - see "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." + see "[Locking conversations](https://docs.github.com/enterprise-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations)." operationId: pull-request/unlocked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -239256,10 +242128,10 @@ webhooks: type: string enum: - unlocked - enterprise: *847 - installation: *848 - number: *899 - organization: *849 + enterprise: *852 + installation: *853 + number: *904 + organization: *854 pull_request: title: Pull Request type: object @@ -241610,7 +244482,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *850 + repository: *855 sender: *4 required: - action @@ -241643,7 +244515,7 @@ webhooks: > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. operationId: push externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#push + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#push parameters: - name: User-Agent in: header @@ -241705,7 +244577,7 @@ webhooks: (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use - the [Commits API](https://docs.github.com/enterprise-cloud@latest//rest/commits) + the [Commits API](https://docs.github.com/enterprise-cloud@latest/rest/commits) to fetch additional commits. type: array items: @@ -241813,7 +244685,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *847 + enterprise: *852 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -241908,8 +244780,8 @@ webhooks: - url - author - committer - installation: *848 - organization: *849 + installation: *853 + organization: *854 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -242451,7 +245323,7 @@ webhooks: registry-package-published: post: summary: |- - This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)" in the REST API documentation. + This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)" in the REST API documentation. To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. @@ -242460,7 +245332,7 @@ webhooks: description: A package was published to a registry. operationId: registry-package/published externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#registry_package parameters: - name: User-Agent in: header @@ -242508,9 +245380,9 @@ webhooks: type: string enum: - published - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 registry_package: type: object properties: @@ -242987,7 +245859,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *888 + items: *893 summary: type: string tag_name: @@ -243043,7 +245915,7 @@ webhooks: - owner - package_version - registry - repository: *850 + repository: *855 sender: *4 required: - action @@ -243064,7 +245936,7 @@ webhooks: registry-package-updated: post: summary: |- - This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)" in the REST API documentation. + This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)" in the REST API documentation. To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. @@ -243073,7 +245945,7 @@ webhooks: description: A package that was previously published to a registry was updated. operationId: registry-package/updated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#registry_package parameters: - name: User-Agent in: header @@ -243121,9 +245993,9 @@ webhooks: type: string enum: - updated - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 registry_package: type: object properties: @@ -243435,7 +246307,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *888 + items: *893 summary: type: string tag_name: @@ -243485,7 +246357,7 @@ webhooks: - owner - package_version - registry - repository: *850 + repository: *855 sender: *4 required: - action @@ -243506,14 +246378,14 @@ webhooks: release-created: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A draft was saved, or a release or pre-release was published without previously being saved as a draft. operationId: release/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -243562,12 +246434,12 @@ webhooks: type: string enum: - created - enterprise: *847 - installation: *848 - organization: *849 - release: &906 + enterprise: *852 + installation: *853 + organization: *854 + release: &911 title: Release - description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) + description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object. type: object properties: @@ -243896,7 +246768,7 @@ webhooks: - updated_at - zipball_url - body - repository: *850 + repository: *855 sender: *4 required: - action @@ -243918,13 +246790,13 @@ webhooks: release-deleted: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release, pre-release, or draft release was deleted. operationId: release/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -243973,11 +246845,11 @@ webhooks: type: string enum: - deleted - enterprise: *847 - installation: *848 - organization: *849 - release: *906 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + release: *911 + repository: *855 sender: *4 required: - action @@ -243999,14 +246871,14 @@ webhooks: release-edited: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: The details of a release, pre-release, or draft release were edited. - For more information, see "[Managing releases in a repository](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)." + For more information, see "[Managing releases in a repository](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)." operationId: release/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -244094,11 +246966,11 @@ webhooks: type: boolean required: - to - enterprise: *847 - installation: *848 - organization: *849 - release: *906 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + release: *911 + repository: *855 sender: *4 required: - action @@ -244120,14 +246992,14 @@ webhooks: release-prereleased: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable. operationId: release/prereleased externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -244176,12 +247048,12 @@ webhooks: type: string enum: - prereleased - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 release: title: Release - description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) + description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object. type: object required: @@ -244514,7 +247386,7 @@ webhooks: - string - 'null' format: uri - repository: *850 + repository: *855 sender: *4 required: - action @@ -244535,13 +247407,13 @@ webhooks: release-published: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release, pre-release, or draft of a release was published. operationId: release/published externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -244590,12 +247462,12 @@ webhooks: type: string enum: - published - enterprise: *847 - installation: *848 - organization: *849 - release: &907 + enterprise: *852 + installation: *853 + organization: *854 + release: &912 title: Release - description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) + description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object. type: object required: @@ -244926,7 +247798,7 @@ webhooks: - string - 'null' format: uri - repository: *850 + repository: *855 sender: *4 required: - action @@ -244947,13 +247819,13 @@ webhooks: release-released: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release was published, or a pre-release was changed to a release. operationId: release/released externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -245002,11 +247874,11 @@ webhooks: type: string enum: - released - enterprise: *847 - installation: *848 - organization: *849 - release: *906 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + release: *911 + repository: *855 sender: *4 required: - action @@ -245027,13 +247899,13 @@ webhooks: release-unpublished: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release or pre-release was unpublished. operationId: release/unpublished externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -245082,11 +247954,11 @@ webhooks: type: string enum: - unpublished - enterprise: *847 - installation: *848 - organization: *849 - release: *907 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + release: *912 + repository: *855 sender: *4 required: - action @@ -245107,13 +247979,13 @@ webhooks: repository-advisory-published: post: summary: |- - This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." + This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. description: A repository security advisory was published. operationId: repository-advisory/published externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_advisory parameters: - name: User-Agent in: header @@ -245162,11 +248034,11 @@ webhooks: type: string enum: - published - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 - repository_advisory: *749 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + repository_advisory: *753 sender: *4 required: - action @@ -245187,13 +248059,13 @@ webhooks: repository-advisory-reported: post: summary: |- - This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." + This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. description: A private vulnerability report was submitted. operationId: repository-advisory/reported externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_advisory parameters: - name: User-Agent in: header @@ -245242,11 +248114,11 @@ webhooks: type: string enum: - reported - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 - repository_advisory: *749 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + repository_advisory: *753 sender: *4 required: - action @@ -245267,13 +248139,13 @@ webhooks: repository-archived: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: A repository was archived. operationId: repository/archived externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -245322,10 +248194,10 @@ webhooks: type: string enum: - archived - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -245347,13 +248219,13 @@ webhooks: repository-created: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: A repository was created. operationId: repository/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -245402,10 +248274,10 @@ webhooks: type: string enum: - created - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -245427,14 +248299,14 @@ webhooks: repository-deleted: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: A repository was deleted. GitHub Apps and repository webhooks will not receive this event. operationId: repository/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -245483,10 +248355,10 @@ webhooks: type: string enum: - deleted - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -245508,12 +248380,12 @@ webhooks: repository-dispatch-sample.collected: post: summary: |- - This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. + This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. operationId: repository-dispatch/sample.collected externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_dispatch + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_dispatch parameters: - name: User-Agent in: header @@ -245571,10 +248443,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -245596,14 +248468,14 @@ webhooks: repository-edited: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: The topics, default branch, description, or homepage of a repository was changed. operationId: repository/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -245689,10 +248561,10 @@ webhooks: - 'null' items: type: string - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -245715,11 +248587,11 @@ webhooks: repository-import: post: summary: This event occurs when a repository is imported to GitHub Enterprise - Cloud. For more information, see "[Importing a repository with GitHub Importer](https://docs.github.com/enterprise-cloud@latest//get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer)." - For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports). + Cloud. For more information, see "[Importing a repository with GitHub Importer](https://docs.github.com/enterprise-cloud@latest/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer)." + For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports). operationId: repository-import externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_import + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_import parameters: - name: User-Agent in: header @@ -245764,10 +248636,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 status: type: string @@ -245793,13 +248665,13 @@ webhooks: repository-privatized: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: The visibility of a repository was changed to `private`. operationId: repository/privatized externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -245848,10 +248720,10 @@ webhooks: type: string enum: - privatized - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -245873,13 +248745,13 @@ webhooks: repository-publicized: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: The visibility of a repository was changed to `public`. operationId: repository/publicized externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -245928,10 +248800,10 @@ webhooks: type: string enum: - publicized - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -245953,13 +248825,13 @@ webhooks: repository-renamed: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: The name of a repository was changed. operationId: repository/renamed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -246025,10 +248897,10 @@ webhooks: - name required: - repository - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -246052,14 +248924,14 @@ webhooks: post: summary: |- This event occurs when there is activity relating to repository rulesets. - For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." - For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation." + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-cloud@latest/rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules) in the REST API documentation." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. description: A repository ruleset was created. operationId: repository-ruleset/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_ruleset parameters: - name: User-Agent in: header @@ -246108,10 +248980,10 @@ webhooks: type: string enum: - created - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 repository_ruleset: *187 sender: *4 required: @@ -246134,14 +249006,14 @@ webhooks: post: summary: |- This event occurs when there is activity relating to repository rulesets. - For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." - For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation." + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-cloud@latest/rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules) in the REST API documentation." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. description: A repository ruleset was deleted. operationId: repository-ruleset/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_ruleset parameters: - name: User-Agent in: header @@ -246190,10 +249062,10 @@ webhooks: type: string enum: - deleted - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 repository_ruleset: *187 sender: *4 required: @@ -246216,14 +249088,14 @@ webhooks: post: summary: |- This event occurs when there is activity relating to repository rulesets. - For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." - For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation." + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-cloud@latest/rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules) in the REST API documentation." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. description: A repository ruleset was edited. operationId: repository-ruleset/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_ruleset parameters: - name: User-Agent in: header @@ -246272,10 +249144,10 @@ webhooks: type: string enum: - edited - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 repository_ruleset: *187 changes: type: object @@ -246337,16 +249209,16 @@ webhooks: properties: added: type: array - items: *717 + items: *721 deleted: type: array - items: *717 + items: *721 updated: type: array items: type: object properties: - rule: *717 + rule: *721 changes: type: object properties: @@ -246385,7 +249257,7 @@ webhooks: repository-transferred: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: Ownership of the repository was transferred to a user or organization @@ -246395,7 +249267,7 @@ webhooks: events. operationId: repository/transferred externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -246583,10 +249455,10 @@ webhooks: - from required: - owner - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -246609,13 +249481,13 @@ webhooks: repository-unarchived: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: A previously archived repository was unarchived. operationId: repository/unarchived externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -246664,10 +249536,10 @@ webhooks: type: string enum: - unarchived - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -246696,7 +249568,7 @@ webhooks: description: A repository vulnerability alert was created. operationId: repository-vulnerability-alert/create externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -246745,7 +249617,7 @@ webhooks: type: string enum: - create - alert: &908 + alert: &913 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -246870,10 +249742,10 @@ webhooks: enum: - auto_dismissed - open - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -246901,7 +249773,7 @@ webhooks: description: A repository vulnerability alert was dismissed. operationId: repository-vulnerability-alert/dismiss externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -247083,10 +249955,10 @@ webhooks: type: string enum: - dismissed - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -247115,7 +249987,7 @@ webhooks: was reopened. operationId: repository-vulnerability-alert/reopen externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -247164,11 +250036,11 @@ webhooks: type: string enum: - reopen - alert: *908 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + alert: *913 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -247196,7 +250068,7 @@ webhooks: description: A repository vulnerability alert was marked as resolved. operationId: repository-vulnerability-alert/resolve externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -247370,10 +250242,10 @@ webhooks: enum: - fixed - open - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -247394,7 +250266,7 @@ webhooks: secret-scanning-alert-assigned: post: summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. @@ -247402,7 +250274,7 @@ webhooks: description: A secret scanning alert was assigned. operationId: secret-scanning-alert/assigned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -247451,7 +250323,7 @@ webhooks: type: string enum: - assigned - alert: &909 + alert: &914 type: object properties: number: *127 @@ -247503,7 +250375,7 @@ webhooks: type: string description: |- User-friendly name for the detected secret, matching the `secret_type`. - For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." provider: type: - string @@ -247591,10 +250463,10 @@ webhooks: - type: 'null' - *4 assignee: *4 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -247615,7 +250487,7 @@ webhooks: secret-scanning-alert-created: post: summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. @@ -247623,7 +250495,7 @@ webhooks: description: A secret scanning alert was created. operationId: secret-scanning-alert/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -247672,11 +250544,11 @@ webhooks: type: string enum: - created - alert: *909 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + alert: *914 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -247699,7 +250571,7 @@ webhooks: summary: |- This event occurs when there is activity relating to the locations of a secret in a secret scanning alert. - For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alerts, use the `secret_scanning_alert` event. @@ -247708,7 +250580,7 @@ webhooks: a repository, and the location of the secret was added to the existing alert. operationId: secret-scanning-alert-location/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert_location parameters: - name: User-Agent in: header @@ -247757,11 +250629,11 @@ webhooks: type: string enum: - created - alert: *909 - installation: *848 - location: *910 - organization: *849 - repository: *850 + alert: *914 + installation: *853 + location: *915 + organization: *854 + repository: *855 sender: *4 required: - location @@ -247942,7 +250814,7 @@ webhooks: secret-scanning-alert-publicly-leaked: post: summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. @@ -247950,7 +250822,7 @@ webhooks: description: A secret scanning alert was detected in a public repo. operationId: secret-scanning-alert/publicly-leaked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -247999,11 +250871,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *909 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + alert: *914 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -248024,7 +250896,7 @@ webhooks: secret-scanning-alert-reopened: post: summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. @@ -248032,7 +250904,7 @@ webhooks: description: A previously closed secret scanning alert was reopened. operationId: secret-scanning-alert/reopened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -248081,11 +250953,11 @@ webhooks: type: string enum: - reopened - alert: *909 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + alert: *914 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -248106,7 +250978,7 @@ webhooks: secret-scanning-alert-resolved: post: summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. @@ -248114,7 +250986,7 @@ webhooks: description: A secret scanning alert was closed. operationId: secret-scanning-alert/resolved externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -248163,11 +251035,11 @@ webhooks: type: string enum: - resolved - alert: *909 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + alert: *914 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -248188,7 +251060,7 @@ webhooks: secret-scanning-alert-unassigned: post: summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. @@ -248196,7 +251068,7 @@ webhooks: description: A secret scanning alert was unassigned. operationId: secret-scanning-alert/unassigned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -248245,12 +251117,12 @@ webhooks: type: string enum: - unassigned - alert: *909 + alert: *914 assignee: *4 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -248271,7 +251143,7 @@ webhooks: secret-scanning-alert-validated: post: summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. @@ -248279,7 +251151,7 @@ webhooks: description: A secret scanning alert was validated. operationId: secret-scanning-alert/validated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -248328,11 +251200,11 @@ webhooks: type: string enum: - validated - alert: *909 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + alert: *914 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -248353,16 +251225,16 @@ webhooks: secret-scanning-scan-completed: post: summary: |- - This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." + This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning)." Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates - to patterns from partners. For more information on custom patterns, see "[About custom patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns)." + to patterns from partners. For more information on custom patterns, see "[About custom patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns)." To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. description: A secret scanning scan was completed. operationId: secret-scanning-scan/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_scan + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_scan parameters: - name: User-Agent in: header @@ -248462,10 +251334,10 @@ webhooks: - organization - enterprise - - repository: *850 - enterprise: *847 - installation: *848 - organization: *849 + repository: *855 + enterprise: *852 + installation: *853 + organization: *854 sender: *4 required: - action @@ -248488,13 +251360,13 @@ webhooks: security-advisory-published: post: summary: |- - This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory). + This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#securityadvisory). - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." description: A security advisory was published to the GitHub community. operationId: security-advisory/published externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -248543,11 +251415,11 @@ webhooks: type: string enum: - published - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 - security_advisory: &911 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + security_advisory: &916 description: The details of the security advisory, including summary, description, and severity. type: object @@ -248678,13 +251550,13 @@ webhooks: security-advisory-updated: post: summary: |- - This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory). + This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#securityadvisory). - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." description: The metadata or description of a security advisory was changed. operationId: security-advisory/updated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -248733,11 +251605,11 @@ webhooks: type: string enum: - updated - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 - security_advisory: *911 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + security_advisory: *916 sender: *4 required: - action @@ -248755,13 +251627,13 @@ webhooks: security-advisory-withdrawn: post: summary: |- - This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory). + This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/enterprise-cloud@latest/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#securityadvisory). - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." description: A previously published security advisory was withdrawn. operationId: security-advisory/withdrawn externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -248810,10 +251682,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -248943,12 +251815,12 @@ webhooks: security-and-analysis: post: summary: |- - This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/enterprise-cloud@latest//code-security/getting-started/github-security-features)." + This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/enterprise-cloud@latest/code-security/getting-started/github-security-features)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. operationId: security-and-analysis externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_and_analysis + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#security_and_analysis parameters: - name: User-Agent in: header @@ -248999,11 +251871,11 @@ webhooks: from: type: object properties: - security_and_analysis: *421 - enterprise: *847 - installation: *848 - organization: *849 - repository: *466 + security_and_analysis: *425 + enterprise: *852 + installation: *853 + organization: *854 + repository: *470 sender: *4 required: - changes @@ -249023,16 +251895,16 @@ webhooks: sponsorship-cancelled: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship). + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship). - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: |- A sponsorship was cancelled and the last billing cycle has ended. This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. operationId: sponsorship/cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -249081,12 +251953,12 @@ webhooks: type: string enum: - cancelled - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - sponsorship: &912 + sponsorship: &917 type: object properties: created_at: @@ -249335,14 +252207,14 @@ webhooks: sponsorship-created: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship). + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship). - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed. operationId: sponsorship/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -249391,12 +252263,12 @@ webhooks: type: string enum: - created - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - sponsorship: *912 + sponsorship: *917 required: - action - sponsorship @@ -249414,15 +252286,15 @@ webhooks: sponsorship-edited: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship). + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship). - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs. operationId: sponsorship/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -249484,12 +252356,12 @@ webhooks: type: string required: - from - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - sponsorship: *912 + sponsorship: *917 required: - action - changes @@ -249508,16 +252380,16 @@ webhooks: sponsorship-pending-cancellation: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship). + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship). - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: |- A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. operationId: sponsorship/pending-cancellation externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -249566,17 +252438,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &913 + effective_date: &918 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - sponsorship: *912 + sponsorship: *917 required: - action - sponsorship @@ -249594,14 +252466,14 @@ webhooks: sponsorship-pending-tier-change: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship). + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship). - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date. operationId: sponsorship/pending-tier-change externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -249650,7 +252522,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &914 + changes: &919 type: object properties: tier: @@ -249694,13 +252566,13 @@ webhooks: - from required: - tier - effective_date: *913 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + effective_date: *918 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - sponsorship: *912 + sponsorship: *917 required: - action - changes @@ -249719,16 +252591,16 @@ webhooks: sponsorship-tier-changed: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship). + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#sponsorship). - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle. operationId: sponsorship/tier-changed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -249777,13 +252649,13 @@ webhooks: type: string enum: - tier_changed - changes: *914 - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + changes: *919 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - sponsorship: *912 + sponsorship: *917 required: - action - changes @@ -249802,13 +252674,13 @@ webhooks: star-created: post: summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)" in the REST API documentation. + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/enterprise-cloud@latest/rest/activity/starring)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: Someone starred a repository. operationId: star/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -249857,10 +252729,10 @@ webhooks: type: string enum: - created - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -249889,13 +252761,13 @@ webhooks: star-deleted: post: summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)" in the REST API documentation. + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/enterprise-cloud@latest/rest/activity/starring)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: Someone unstarred the repository. operationId: star/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -249944,10 +252816,10 @@ webhooks: type: string enum: - deleted - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -249975,12 +252847,12 @@ webhooks: status: post: summary: |- - This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses)" in the REST API documentation. + This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. operationId: status externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#status + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#status parameters: - name: User-Agent in: header @@ -250381,15 +253253,15 @@ webhooks: type: - string - 'null' - enterprise: *847 + enterprise: *852 id: description: The unique identifier of the status. type: integer - installation: *848 + installation: *853 name: type: string - organization: *849 - repository: *850 + organization: *854 + repository: *855 sender: *4 sha: description: The Commit SHA. @@ -250447,7 +253319,7 @@ webhooks: description: A parent issue was added to an issue. operationId: sub-issues/parent-issue-added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -250505,9 +253377,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *219 - installation: *848 - organization: *849 - repository: *850 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -250539,7 +253411,7 @@ webhooks: description: A parent issue was removed from an issue. operationId: sub-issues/parent-issue-removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -250597,9 +253469,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *219 - installation: *848 - organization: *849 - repository: *850 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -250631,7 +253503,7 @@ webhooks: description: A sub-issue was added to an issue. operationId: sub-issues/sub-issue-added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -250689,9 +253561,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *219 - installation: *848 - organization: *849 - repository: *850 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -250723,7 +253595,7 @@ webhooks: description: A sub-issue was removed from an issue. operationId: sub-issues/sub-issue-removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -250781,9 +253653,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *219 - installation: *848 - organization: *849 - repository: *850 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -250808,14 +253680,14 @@ webhooks: post: summary: |- This event occurs when a team is added to a repository. - For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." + For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." For activity relating to teams, see the `teams` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. operationId: team-add externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team_add + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team_add parameters: - name: User-Agent in: header @@ -250860,12 +253732,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - team: &915 + team: &920 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -251040,13 +253912,13 @@ webhooks: post: summary: |- This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." + For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: A team was granted access to a repository. operationId: team/added-to-repository externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header @@ -251095,9 +253967,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 repository: title: Repository description: A git repository @@ -251567,7 +254439,7 @@ webhooks: - topics - visibility sender: *4 - team: *915 + team: *920 required: - action - team @@ -251588,13 +254460,13 @@ webhooks: post: summary: |- This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." + For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: A team was created. operationId: team/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header @@ -251643,9 +254515,9 @@ webhooks: type: string enum: - created - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 repository: title: Repository description: A git repository @@ -252115,7 +254987,7 @@ webhooks: - topics - visibility sender: *4 - team: *915 + team: *920 required: - action - team @@ -252137,13 +255009,13 @@ webhooks: post: summary: |- This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." + For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: A team was deleted. operationId: team/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header @@ -252192,9 +255064,9 @@ webhooks: type: string enum: - deleted - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 repository: title: Repository description: A git repository @@ -252664,7 +255536,7 @@ webhooks: - topics - visibility sender: *4 - team: *915 + team: *920 required: - action - team @@ -252685,13 +255557,13 @@ webhooks: post: summary: |- This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." + For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: The name, description, or visibility of a team was changed. operationId: team/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header @@ -252808,9 +255680,9 @@ webhooks: - from required: - permissions - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 repository: title: Repository description: A git repository @@ -253280,7 +256152,7 @@ webhooks: - topics - visibility sender: *4 - team: *915 + team: *920 required: - action - changes @@ -253303,13 +256175,13 @@ webhooks: post: summary: |- This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." + For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: A team's access to a repository was removed. operationId: team/removed-from-repository externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header @@ -253358,9 +256230,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *847 - installation: *848 - organization: *849 + enterprise: *852 + installation: *853 + organization: *854 repository: title: Repository description: A git repository @@ -253830,7 +256702,7 @@ webhooks: - topics - visibility sender: *4 - team: *915 + team: *920 required: - action - team @@ -253851,13 +256723,13 @@ webhooks: watch-started: post: summary: |- - This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see "[Managing your subscriptions](https://docs.github.com/enterprise-cloud@latest//account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions)." For information about the APIs to manage watching, see "[Watching](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching)" in the REST API documentation. + This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see "[Managing your subscriptions](https://docs.github.com/enterprise-cloud@latest/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions)." For information about the APIs to manage watching, see "[Watching](https://docs.github.com/enterprise-cloud@latest/rest/activity/watching)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: Someone started watching the repository. operationId: watch/started externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#watch + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#watch parameters: - name: User-Agent in: header @@ -253906,10 +256778,10 @@ webhooks: type: string enum: - started - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -253930,14 +256802,14 @@ webhooks: workflow-dispatch: post: summary: |- - This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "[Manually running a workflow](https://docs.github.com/enterprise-cloud@latest//actions/managing-workflow-runs/manually-running-a-workflow)." + This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "[Manually running a workflow](https://docs.github.com/enterprise-cloud@latest/actions/managing-workflow-runs/manually-running-a-workflow)." For activity relating to workflow runs, use the `workflow_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. operationId: workflow-dispatch externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_dispatch + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_dispatch parameters: - name: User-Agent in: header @@ -253982,17 +256854,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *847 + enterprise: *852 inputs: type: - object - 'null' additionalProperties: true - installation: *848 - organization: *849 + installation: *853 + organization: *854 ref: type: string - repository: *850 + repository: *855 sender: *4 workflow: type: string @@ -254015,7 +256887,7 @@ webhooks: workflow-job-completed: post: summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)" in the REST API documentation. + This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs)" in the REST API documentation. For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. @@ -254025,7 +256897,7 @@ webhooks: unsuccessful. operationId: workflow-job/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_job parameters: - name: User-Agent in: header @@ -254074,10 +256946,10 @@ webhooks: type: string enum: - completed - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 workflow_job: allOf: @@ -254119,7 +256991,7 @@ webhooks: type: integer labels: description: Custom labels for the job. Specified by the [`"runs-on"` - attribute](https://docs.github.com/enterprise-cloud@latest//actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) + attribute](https://docs.github.com/enterprise-cloud@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. type: array items: @@ -254333,7 +257205,7 @@ webhooks: type: string required: - conclusion - deployment: *603 + deployment: *607 required: - action - repository @@ -254355,7 +257227,7 @@ webhooks: workflow-job-in-progress: post: summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)" in the REST API documentation. + This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs)" in the REST API documentation. For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. @@ -254363,7 +257235,7 @@ webhooks: description: A job in a workflow run started processing on a runner. operationId: workflow-job/in-progress externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_job parameters: - name: User-Agent in: header @@ -254412,10 +257284,10 @@ webhooks: type: string enum: - in_progress - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 workflow_job: allOf: @@ -254454,7 +257326,7 @@ webhooks: type: integer labels: description: Custom labels for the job. Specified by the [`"runs-on"` - attribute](https://docs.github.com/enterprise-cloud@latest//actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) + attribute](https://docs.github.com/enterprise-cloud@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. type: array items: @@ -254697,7 +257569,7 @@ webhooks: required: - status - steps - deployment: *603 + deployment: *607 required: - action - repository @@ -254719,7 +257591,7 @@ webhooks: workflow-job-queued: post: summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)" in the REST API documentation. + This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs)" in the REST API documentation. For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. @@ -254727,7 +257599,7 @@ webhooks: description: A job in a workflow run was created. operationId: workflow-job/queued externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_job parameters: - name: User-Agent in: header @@ -254776,10 +257648,10 @@ webhooks: type: string enum: - queued - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 workflow_job: type: object @@ -254925,7 +257797,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *603 + deployment: *607 required: - action - repository @@ -254947,7 +257819,7 @@ webhooks: workflow-job-waiting: post: summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)" in the REST API documentation. + This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs)" in the REST API documentation. For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. @@ -254955,7 +257827,7 @@ webhooks: description: A job in a workflow run was created and is waiting for approvals. operationId: workflow-job/waiting externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_job parameters: - name: User-Agent in: header @@ -255004,10 +257876,10 @@ webhooks: type: string enum: - waiting - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 workflow_job: type: object @@ -255154,7 +258026,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *603 + deployment: *607 required: - action - repository @@ -255176,7 +258048,7 @@ webhooks: workflow-run-completed: post: summary: |- - This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/enterprise-cloud@latest//actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs)" in the REST API documentation. + This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/enterprise-cloud@latest/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs)" in the REST API documentation. For activity relating to a job in a workflow run, use the `workflow_job` event. @@ -255185,7 +258057,7 @@ webhooks: is completed, regardless of whether the workflow was successful or unsuccessful. operationId: workflow-run/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_run + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_run parameters: - name: User-Agent in: header @@ -255234,12 +258106,12 @@ webhooks: type: string enum: - completed - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - workflow: *864 + workflow: *869 workflow_run: title: Workflow Run type: object @@ -256201,7 +259073,7 @@ webhooks: workflow-run-in-progress: post: summary: |- - This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/enterprise-cloud@latest//actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs)" in the REST API documentation. + This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/enterprise-cloud@latest/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs)" in the REST API documentation. For activity relating to a job in a workflow run, use the `workflow_job` event. @@ -256209,7 +259081,7 @@ webhooks: description: A workflow run started processing on a runner. operationId: workflow-run/in-progress externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_run + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#workflow_run parameters: - name: User-Agent in: header @@ -256258,12 +259130,12 @@ webhooks: type: string enum: - in_progress - enterprise: *847 - installation: *848 - organization: *849 - repository: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - workflow: *864 + workflow: *869 workflow_run: title: Workflow Run type: object @@ -257210,7 +260082,7 @@ webhooks: workflow-run-requested: post: summary: |- - This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/enterprise-cloud@latest//actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs)" in the REST API documentation. + This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/enterprise-cloud@latest/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs)" in the REST API documentation. For activity relating to a job in a workflow run, use the `workflow_job` event. @@ -257218,7 +260090,7 @@ webhooks: description: A workflow run was triggered. operationId: workflow-run/requested externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/web{"code":"deadline_exceeded","msg":"operation timed out"}